Commit 127ab0ed authored by Katherina Baber's avatar Katherina Baber
Browse files

corrected documentation


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7750 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 02e7227d
......@@ -93,14 +93,15 @@ SET_BOOL_PROP(OnePTestProblem, EnableGravity, true);
/*!
* \ingroup OnePBoxModel
* \ingroup BoxTestProblems
* \brief Air flow in porous media
* \brief Test problem for the one-phase box model:
* water is flowing from bottom to top through and around a low permeable lens.
*
* The domain is box shaped. All sides are closed (Neumann 0 boundary)
* except the top and bottom boundaries (Dirichlet), where water is
* flowing from bottom to top.
*
* In the middle of the domain, a lens with low permeability (\f$ K=10e-12f$)
* compared to the surrounding material (\f$ K=10e-10f$) is defined.
* In the middle of the domain, a lens with low permeability (\f$K=10e-12\f$)
* compared to the surrounding material (\f$ K=10e-10\f$) is defined.
*
* To run the simulation execute the following line in shell:
* <tt>./test_1p -parameterFile test_1p.input</tt>
......@@ -167,14 +168,14 @@ public:
*/
Scalar temperature() const
{ return 273.15 + 10; } // 10C
// \}
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
values = 0;
}
// \}
/*!
* \name Boundary conditions
*/
......
......@@ -82,8 +82,7 @@ public:
}
/*!
* \brief Apply the intrinsic permeability tensor to a pressure
* potential gradient.
* \brief Return the intrinsic permeability for the current sub-control volume.
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
......
......@@ -48,7 +48,13 @@ void usage(const char *progName, const std::string &errorMsg)
"\t-tEnd The end of the simulation. [s] \n"
"\t-dtInitial The initial timestep size. [s] \n"
"\t-gridFile The file name of the file containing the grid \n"
"\t definition in DGF format\n";
"\t definition in DGF format\n"
"\t-SpatialParameters.lensLowerLeftX Dimension of the lens [m] \n"
"\t-SpatialParameters.lensLowerLeftY Dimension of the lens [m] \n"
"\t-SpatialParameters.lensUpperRightX Dimension of the lens [m] \n"
"\t-SpatialParameters.lensUpperRighty Dimension of the lens [m] \n"
"\t-SpatialParameters.permeability Permeability of the domain [mm^2] \n"
"\t-SpatialParameters.permeabilityLens Permeability of the lens [mm^2] \n";
std::cout << errorMessageOut
<< "\n";
......
......@@ -98,7 +98,7 @@ SET_BOOL_PROP(OnePTwoCOutflowProblem, EnableGravity, false);
* is transported with the water flow from the left side to the right.
*
* The model domain is 1m times 1m with a discretization length of 0.05m
* and homogeneous soil properties (\f$ K=10e-10, \Phi=0.4\f$).
* and homogeneous soil properties (\f$ \mathrm{K=10e-10, \Phi=0.4}\f$).
* Initially the domain is filled with pure water.
*
* At the left side, a Dirichlet condition defines a nitrogen mole fraction
......
......@@ -91,7 +91,7 @@ public:
};
/*!
* \brief Define the intrinsic permeability \f$[m^2]\f$.
* \brief Define the intrinsic permeability \f$\mathrm{[m^2]}\f$.
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
......@@ -105,7 +105,7 @@ public:
}
/*!
* \brief Define the porosity \f$[-]\f$.
* \brief Define the porosity \f$\mathrm{[-]}\f$.
*
* \param element The finite element
* \param fvElemGeom The finite volume geometry
......@@ -119,7 +119,7 @@ public:
}
/*!
* \brief Define the tortuosity \f$[?]\f$.
* \brief Define the tortuosity \f$\mathrm{[-]}\f$.
*
* \param element The finite element
* \param fvElemGeom The finite volume geometry
......@@ -133,7 +133,7 @@ public:
}
/*!
* \brief Define the dispersivity \f$[?]\f$.
* \brief Define the dispersivity.
*
* \param element The finite element
* \param fvElemGeom The finite volume geometry
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment