Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
dumux-repositories
dumux
Commits
2669311d
Commit
2669311d
authored
Dec 21, 2017
by
Sina Ackermann
Browse files
[doc][freeflow][test] Add ingroup NavierStokesTests
parent
d6f2abcd
Changes
5
Hide whitespace changes
Inline
Side-by-side
test/freeflow/navierstokes/angelitestproblem.hh
View file @
2669311d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
*
\ingroup NavierStokesTests
* \brief Test for the instationary staggered grid Navier-Stokes model with analytical solution (Angeli et al., 2017)
*/
#ifndef DUMUX_ANGELI_TEST_PROBLEM_HH
...
...
@@ -65,7 +65,7 @@ SET_BOOL_PROP(AngeliTestProblem, EnableInertiaTerms, true);
}
/*!
* \ingroup
ImplicitTestProblem
s
* \ingroup
NavierStokesTest
s
* \brief Test problem for the staggered grid (Angeli 1947)
* \todo doc me!
*/
...
...
@@ -131,7 +131,7 @@ public:
cellSizeX_
=
this
->
fvGridGeometry
().
bBoxMax
()[
0
]
/
numCells
[
0
];
}
/*!
/*!
* \name Problem parameters
*/
// \{
...
...
@@ -158,7 +158,7 @@ public:
}
}
/*!
/*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
...
...
@@ -167,7 +167,7 @@ public:
{
return
298.0
;
}
/*!
/*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
...
...
@@ -178,12 +178,12 @@ public:
}
// \}
/*!
/*!
* \name Boundary conditions
*/
// \{
/*!
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
...
...
@@ -202,7 +202,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Return dirichlet boundary values at a given position
*
* \param globalPos The global position
...
...
@@ -213,7 +213,7 @@ public:
return
analyticalSolution
(
globalPos
,
time
());
}
/*!
/*!
* \brief Return the analytical solution of the problem at a given position
*
* \param globalPos The global position
...
...
@@ -236,12 +236,12 @@ public:
// \}
/*!
/*!
* \name Volume terms
*/
// \{
/*!
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
...
...
@@ -252,7 +252,7 @@ public:
}
/*!
/*!
* \brief Calculate the L2 error between the analytical solution and the numerical approximation.
*
*/
...
...
@@ -324,7 +324,7 @@ public:
return
std
::
make_pair
(
l2NormAbs
,
l2NormRel
);
}
/*!
/*!
* \brief Returns the analytical solution for the pressure
*/
auto
&
getAnalyticalPressureSolution
()
const
...
...
@@ -332,7 +332,7 @@ public:
return
analyticalPressure_
;
}
/*!
/*!
* \brief Returns the analytical solution for the velocity
*/
auto
&
getAnalyticalVelocitySolution
()
const
...
...
@@ -340,7 +340,7 @@ public:
return
analyticalVelocity_
;
}
/*!
/*!
* \brief Returns the analytical solution for the velocity at the faces
*/
auto
&
getAnalyticalVelocitySolutionOnFace
()
const
...
...
@@ -359,7 +359,7 @@ public:
return
timeLoop_
->
time
();
}
/*!
/*!
* \brief Adds additional VTK output data to the VTKWriter. Function is called by the output module on every write.
*/
void
createAnalyticalSolution
()
...
...
test/freeflow/navierstokes/channeltestproblem.hh
View file @
2669311d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
*
\ingroup NavierStokesTests
* \brief Channel flow test for the staggered grid (Navier-)Stokes model
*/
#ifndef DUMUX_CHANNEL_TEST_PROBLEM_HH
...
...
@@ -77,8 +77,9 @@ SET_BOOL_PROP(ChannelTestProblem, EnableInertiaTerms, false);
}
/*!
* \brief Test problem for the one-phase (Navier-) Stokes problem in a channel:
\todo doc me!
* \ingroup NavierStokesTests
* \brief Test problem for the one-phase (Navier-) Stokes problem in a channel.
* \todo doc me!
*/
template
<
class
TypeTag
>
class
ChannelTestProblem
:
public
NavierStokesProblem
<
TypeTag
>
...
...
@@ -132,7 +133,7 @@ public:
inletVelocity_
=
getParam
<
Scalar
>
(
"Problem.InletVelocity"
);
}
/*!
/*!
* \name Problem parameters
*/
// \{
...
...
@@ -143,7 +144,7 @@ public:
return
false
;
}
/*!
/*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
...
...
@@ -151,7 +152,7 @@ public:
Scalar
temperature
()
const
{
return
273.15
+
10
;
}
// 10C
/*!
/*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
...
...
@@ -161,12 +162,12 @@ public:
return
SourceValues
(
0.0
);
}
// \}
/*!
/*!
* \name Boundary conditions
*/
// \{
/*!
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
...
...
@@ -198,7 +199,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
...
...
@@ -223,12 +224,12 @@ public:
// \}
/*!
/*!
* \name Volume terms
*/
// \{
/*!
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
...
...
test/freeflow/navierstokes/closedsystemtestproblem.hh
View file @
2669311d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
*
\ingroup NavierStokesTests
* \brief A test problem for the staggered (Navier-) Stokes model
*/
#ifndef DUMUX_CLOSEDSYSTEM_TEST_PROBLEM_HH
...
...
@@ -62,8 +62,9 @@ SET_BOOL_PROP(ClosedSystemTestProblem, EnableGridVolumeVariablesCache, true);
}
/*!
* \brief Test problem for the one-phase model:
\todo doc me!
* \ingroup NavierStokesTests
* \brief Test problem for the one-phase model.
* \todo doc me!
*/
template
<
class
TypeTag
>
class
ClosedSystemTestProblem
:
public
NavierStokesProblem
<
TypeTag
>
...
...
@@ -120,7 +121,7 @@ public:
cellSizeX_
=
this
->
fvGridGeometry
().
bBoxMax
()[
0
]
/
numCells
[
0
];
}
/*!
/*!
* \name Problem parameters
*/
// \{
...
...
@@ -131,7 +132,7 @@ public:
return
false
;
}
/*!
/*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
...
...
@@ -139,7 +140,7 @@ public:
Scalar
temperature
()
const
{
return
273.15
+
10
;
}
// 10C
/*!
/*!
* \brief Return the sources within the domain.
*
* \param values Stores the source values, acts as return value
...
...
@@ -150,12 +151,12 @@ public:
return
SourceValues
(
0.0
);
}
// \}
/*!
/*!
* \name Boundary conditions
*/
// \{
/*!
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
...
...
@@ -178,7 +179,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Return dirichlet boundary values at a given position
*
* \param globalPos The global position
...
...
@@ -196,7 +197,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
...
...
test/freeflow/navierstokes/doneatestproblem.hh
View file @
2669311d
...
...
@@ -20,7 +20,7 @@
*****************************************************************************/
/*!
* \file
*
*
\ingroup NavierStokesTests
* \brief Test for the staggered grid (Navier-)Stokes model with analytical solution (Donea et al., 2003)
*/
#ifndef DUMUX_DONEA_TEST_PROBLEM_HH
...
...
@@ -70,7 +70,7 @@ SET_BOOL_PROP(DoneaTestProblem, EnableInertiaTerms, false);
}
/*!
* \ingroup
ImplicitTestProblem
s
* \ingroup
NavierStokesTest
s
* \brief Test problem for the staggered grid (Donea et al., 2003)
* \todo doc me!
*/
...
...
@@ -130,12 +130,12 @@ public:
createAnalyticalSolution_
();
}
/*!
/*!
* \name Problem parameters
*/
// \{
/*!
/*!
* \brief The problem name.
*
* This is used as a prefix for files generated by the simulation.
...
...
@@ -167,7 +167,7 @@ public:
}
}
/*!
/*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
...
...
@@ -175,7 +175,7 @@ public:
Scalar
temperature
()
const
{
return
298.0
;
}
/*!
/*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
...
...
@@ -196,12 +196,12 @@ public:
return
source
;
}
// \}
/*!
/*!
* \name Boundary conditions
*/
// \{
/*!
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
...
...
@@ -218,7 +218,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Return dirichlet boundary values at a given position
*
* \param globalPos The global position
...
...
@@ -229,7 +229,7 @@ public:
return
analyticalSolution
(
globalPos
);
}
/*!
/*!
* \brief Return the analytical solution of the problem at a given position
*
* \param globalPos The global position
...
...
@@ -249,12 +249,12 @@ public:
// \}
/*!
/*!
* \name Volume terms
*/
// \{
/*!
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
...
...
@@ -269,7 +269,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Calculate the L2 error between the analytical solution and the numerical approximation.
*
*/
...
...
@@ -341,7 +341,7 @@ public:
return
std
::
make_pair
(
l2NormAbs
,
l2NormRel
);
}
/*!
/*!
* \brief Returns the analytical solution for the pressure
*/
auto
&
getAnalyticalPressureSolution
()
const
...
...
@@ -349,7 +349,7 @@ public:
return
analyticalPressure_
;
}
/*!
/*!
* \brief Returns the analytical solution for the velocity
*/
auto
&
getAnalyticalVelocitySolution
()
const
...
...
@@ -357,7 +357,7 @@ public:
return
analyticalVelocity_
;
}
/*!
/*!
* \brief Returns the analytical solution for the velocity at the faces
*/
auto
&
getAnalyticalVelocitySolutionOnFace
()
const
...
...
@@ -367,7 +367,7 @@ public:
private:
/*!
/*!
* \brief Adds additional VTK output data to the VTKWriter. Function is called by the output module on every write.
*/
void
createAnalyticalSolution_
()
...
...
test/freeflow/navierstokes/kovasznaytestproblem.hh
View file @
2669311d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
*
\ingroup NavierStokesTests
* \brief Test for the staggered grid Navier-Stokes model with analytical solution (Kovasznay 1947)
*/
#ifndef DUMUX_KOVASZNAY_TEST_PROBLEM_HH
...
...
@@ -63,7 +63,7 @@ SET_BOOL_PROP(KovasznayTestProblem, EnableInertiaTerms, true);
}
/*!
* \ingroup
ImplicitTestProblem
s
* \ingroup
NavierStokesTest
s
* \brief Test problem for the staggered grid (Kovasznay 1947)
* \todo doc me!
*/
...
...
@@ -131,7 +131,7 @@ public:
createAnalyticalSolution_
();
}
/*!
/*!
* \name Problem parameters
*/
// \{
...
...
@@ -158,7 +158,7 @@ public:
}
}
/*!
/*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
...
...
@@ -167,7 +167,7 @@ public:
{
return
298.0
;
}
/*!
/*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
...
...
@@ -178,12 +178,12 @@ public:
}
// \}
/*!
/*!
* \name Boundary conditions
*/
// \{
/*!
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
...
...
@@ -205,7 +205,7 @@ public:
return
values
;
}
/*!
/*!
* \brief Return dirichlet boundary values at a given position
*
* \param globalPos The global position
...
...
@@ -216,7 +216,7 @@ public:
return
analyticalSolution
(
globalPos
);
}
/*!
/*!
* \brief Return the analytical solution of the problem at a given position
*
* \param globalPos The global position
...
...
@@ -236,12 +236,12 @@ public:
// \}
/*!
/*!
* \name Volume terms
*/
// \{
/*!
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
...
...
@@ -257,9 +257,10 @@ public:
}
/*!
/*!
* \brief Calculate the L2 error between the analytical solution and the numerical approximation.
*
* \param curSol Vector containing the current solution
*/
auto
calculateL2Error
(
const
SolutionVector
&
curSol
)
const
{
...
...
@@ -329,7 +330,7 @@ public:
return
std
::
make_pair
(
l2NormAbs
,
l2NormRel
);
}
/*!
/*!
* \brief Returns the analytical solution for the pressure
*/
auto
&
getAnalyticalPressureSolution
()
const
...
...
@@ -337,7 +338,7 @@ public:
return
analyticalPressure_
;
}
/*!
/*!
* \brief Returns the analytical solution for the velocity
*/
auto
&
getAnalyticalVelocitySolution
()
const
...
...
@@ -345,7 +346,7 @@ public:
return
analyticalVelocity_
;
}
/*!
/*!
* \brief Returns the analytical solution for the velocity at the faces
*/
auto
&
getAnalyticalVelocitySolutionOnFace
()
const
...
...
@@ -355,7 +356,7 @@ public:
private:
/*!
/*!
* \brief Adds additional VTK output data to the VTKWriter. Function is called by the output module on every write.
*/
void
createAnalyticalSolution_
()
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment