Commit d3655a5b by Martin Schneider

Merge branch 'cleanup/problem-documentation' into 'master'

Cleanup/problem documentation

See merge request !36
parents 974a9719 5b029f4c
 ... ... @@ -152,7 +152,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -181,12 +180,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -221,12 +215,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * * For this method, the \a priVars parameter stores the rate mass * of a component is generated or annihilate per volume * unit. Positive values mean that mass is created, negative ones * mean that it vanishes. * * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s)) * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { ... ... @@ -237,9 +226,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -147,7 +147,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -176,12 +175,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -220,12 +214,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * * For this method, the \a priVars parameter stores the rate mass * of a component is generated or annihilate per volume * unit. Positive values mean that mass is created, negative ones * mean that it vanishes. * * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s)) * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { ... ... @@ -236,9 +225,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -151,7 +151,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -182,12 +181,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -221,12 +215,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * * For this method, the \a priVars parameter stores the rate mass * of a component is generated or annihilate per volume * unit. Positive values mean that mass is created, negative ones * mean that it vanishes. * * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s)) * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { ... ... @@ -237,9 +226,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -153,7 +153,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -184,12 +183,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -223,9 +217,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -132,7 +132,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary control volume. * * \param values The boundary types for the conservation equations * \param globalPos The position of the center of the finite volume */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -152,10 +151,7 @@ public: * \brief Evaluate the boundary conditions for a dirichlet * control volume. * * \param values The dirichlet values for the primary variables * \param globalPos The center of the finite volume which ought to be set. * * For this method, the \a values parameter stores primary variables. */ PrimaryVariables dirichletAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -153,7 +153,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -184,12 +183,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -224,9 +218,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -142,7 +142,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -171,12 +170,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -209,12 +203,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * * For this method, the \a priVars parameter stores the rate mass * of a component is generated or annihilate per volume * unit. Positive values mean that mass is created, negative ones * mean that it vanishes. * * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s)) * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { ... ... @@ -225,9 +214,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -158,7 +158,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -189,12 +188,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -228,9 +222,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -77,7 +77,7 @@ public: // TODO: dumux-course-task // set the OneP Incompressible local residual for the OnePIncompressible type tag. This provides an analytic jacobian to be used for the analytic solution. Change that by setting: //SET_TYPE_PROP(OnePIncompressible, LocalResidual, OnePIncompressibleLocalResidual); SET_TYPE_PROP(OnePIncompressible, LocalResidual, OnePIncompressibleLocalResidual); // the fluid system for compressible tests ... ... @@ -114,17 +114,24 @@ class OnePTestProblem : public PorousMediumFlowProblem using BoundaryTypes = typename GET_PROP_TYPE(TypeTag, BoundaryTypes); static constexpr int dimWorld = GridView::dimensionworld; using GlobalPosition = typename Element::Geometry::GlobalCoordinate; using FluidSystem = typename GET_PROP_TYPE(TypeTag, FluidSystem); public: OnePTestProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) {} { FluidSystem::Component::init(/*tempMin=*/272.15, /*tempMax=*/294.15, /*numTemp=*/10, /*pMin=*/1.0e4, /*pMax=*/1.0e6, /*numP=*/200); } /*! * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary control volume. * * \param values The boundary types for the conservation equations * \param globalPos The position of the center of the finite volume */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -144,10 +151,7 @@ public: * \brief Evaluate the boundary conditions for a dirichlet * control volume. * * \param values The dirichlet values for the primary variables * \param globalPos The center of the finite volume which ought to be set. * * For this method, the \a values parameter stores primary variables. */ PrimaryVariables dirichletAtPos(const GlobalPosition &globalPos) const { ... ...
 ... ... @@ -159,7 +159,6 @@ public: * \brief Specifies which kind of boundary condition should be * used for which equation on a given boundary segment. * * \param bcTypes The boundary types for the conservation equations * \param globalPos The position for which the bc type should be evaluated */ BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const ... ... @@ -190,12 +189,7 @@ public: * \brief Evaluate the boundary conditions for a neumann * boundary segment. * * \param values Stores the Neumann values for the conservation equations in * \f$[ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$ * \param globalPos The position of the integration point of the boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. */ PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const { ... ... @@ -230,9 +224,6 @@ public: * \brief Evaluate the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * * For this method, the \a values parameter stores primary * variables. */ PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const { ... ...
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!