Skip to content

Commit

Permalink
[zeroD] Add doxygen group labels
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl committed Sep 12, 2024
1 parent b938e70 commit 1749566
Show file tree
Hide file tree
Showing 15 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion include/cantera/zeroD/Connector.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class ReactorNode;
*
* @since New in %Cantera 3.1.
*
* @ingroup zerodGroup
* @ingroup connectorGroup
*/
class Connector : public std::enable_shared_from_this<Connector>
{
Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/ConstPressureMoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ class ConstPressureMoleReactor : public MoleReactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<ConstPressureMoleReactor> newConstPressureMoleReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/ConstPressureReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ class ConstPressureReactor : public Reactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<ConstPressureReactor> newConstPressureReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/FlowReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ class FlowReactor : public IdealGasReactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<FlowReactor> newFlowReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/IdealGasConstPressureMoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ class IdealGasConstPressureMoleReactor : public ConstPressureMoleReactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<IdealGasConstPressureMoleReactor> newIdealGasConstPressureMoleReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/IdealGasConstPressureReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ class IdealGasConstPressureReactor : public ConstPressureReactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<IdealGasConstPressureReactor> newIdealGasConstPressureReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/IdealGasMoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ class IdealGasMoleReactor : public MoleReactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<IdealGasMoleReactor> newIdealGasMoleReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/IdealGasReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class IdealGasReactor : public Reactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<IdealGasReactor> newIdealGasReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/MoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ class MoleReactor : public Reactor
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<MoleReactor> newMoleReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/Reactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@ class Reactor : public ReactorBase
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<Reactor> newReactor(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/ReactorDelegator.h
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ class ReactorDelegator : public Delegator, public R, public ReactorAccessor
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @tparam R Type of the delegated reactor class.
//! @ingroup reactorGroup
template <class R>
shared_ptr<ReactorDelegator<R>> newReactorDelegator(
shared_ptr<Solution> contents, const string& name="")
Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/ReactorSurface.h
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ class ReactorSurface : public ReactorNode
//! @param contents Solution object describing contents.
//! @param name Name of the reactor. Optional; if left empty, a default name will be
//! assigned when the reactor is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<ReactorSurface> newReactorSurface(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/Reservoir.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ class Reservoir : public ReactorBase
//! @param contents Solution object describing contents.
//! @param name Name of the reservoir. Optional; if left empty, a default name will be
//! assigned when the object is integrated into a ReactorNet.
//! @ingroup reactorGroup
shared_ptr<Reservoir> newReservoir(
shared_ptr<Solution> contents, const string& name="");

Expand Down
1 change: 1 addition & 0 deletions include/cantera/zeroD/Wall.h
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ class Wall : public WallBase
//! @param r1 Reactor right of the wall.
//! @param name Name of the wall. Optional; if left empty, a default name will be
//! assigned when the wall is integrated into a ReactorNet.
//! @ingroup connectorGroup
shared_ptr<Wall> newWall(
shared_ptr<ReactorNode> r0, shared_ptr<ReactorNode> r1, const string& name="");

Expand Down
3 changes: 3 additions & 0 deletions include/cantera/zeroD/flowControllers.h
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ class Valve : public FlowDevice
//! @param r1 Reactor downstream of the mass flow controller.
//! @param name Name of the mass flow controller. Optional; if left empty, a default
//! name will be assigned when the object is integrated into a ReactorNet.
//! @ingroup connectorGroup
shared_ptr<MassFlowController> newMassFlowController(
shared_ptr<ReactorNode> r0, shared_ptr<ReactorNode> r1, const string& name="");

Expand All @@ -212,6 +213,7 @@ shared_ptr<MassFlowController> newMassFlowController(
//! @param r1 Reactor downstream of the pressure controller.
//! @param name Name of the pressure controller. Optional; if left empty, a default
//! name will be assigned when the object is integrated into a ReactorNet.
//! @ingroup connectorGroup
shared_ptr<PressureController> newPressureController(
shared_ptr<ReactorNode> r0, shared_ptr<ReactorNode> r1, const string& name="");

Expand All @@ -220,6 +222,7 @@ shared_ptr<PressureController> newPressureController(
//! @param r1 Reactor right of the valve.
//! @param name Name of the valve. Optional; if left empty, a default name will be
//! assigned when the object is integrated into a ReactorNet.
//! @ingroup connectorGroup
shared_ptr<Valve> newValve(
shared_ptr<ReactorNode> r0, shared_ptr<ReactorNode> r1, const string& name="");

Expand Down

0 comments on commit 1749566

Please sign in to comment.