Commit 17b24a66 authored by Ivan Buntic's avatar Ivan Buntic Committed by Melanie Lipp
Browse files

[doxygen] Moved copydocs in front of forward declaration.

parent 62fc5331
......@@ -33,14 +33,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCFluxVariablesImpl;
/*!
* \ingroup FreeflowNCModel
* \brief The flux variables class for the multi-component free-flow model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCFluxVariablesImpl;
template<class TypeTag>
class FreeflowNCFluxVariablesImpl<TypeTag, DiscretizationMethod::staggered>
: public NavierStokesFluxVariables<TypeTag>
......
......@@ -30,14 +30,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCResidualImpl;
/*!
* \ingroup FreeflowNCModel
* \brief Element-wise calculation of the multi-component free-flow residual for models using the staggered discretization
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCResidualImpl;
template<class TypeTag>
class FreeflowNCResidualImpl<TypeTag, DiscretizationMethod::staggered>
: public NavierStokesResidual<TypeTag>
......
......@@ -43,14 +43,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesFluxVariablesImpl;
/*!
* \ingroup NavierStokesModel
* \brief The flux variables class for the Navier-Stokes model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesFluxVariablesImpl;
template<class TypeTag>
class NavierStokesFluxVariablesImpl<TypeTag, DiscretizationMethod::staggered>
: public FluxVariablesBase<GetPropType<TypeTag, Properties::Problem>,
......
......@@ -42,14 +42,15 @@ template<int radialAxis>
static constexpr bool isRotationalExtrusion<RotationalExtrusion<radialAxis>> = true;
} // end namespace Impl
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesResidualImpl;
/*!
* \ingroup NavierStokesModel
* \brief Element-wise calculation of the Navier-Stokes residual for models using the staggered discretization
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesResidualImpl;
template<class TypeTag>
class NavierStokesResidualImpl<TypeTag, DiscretizationMethod::staggered>
: public StaggeredLocalResidual<TypeTag>
......
......@@ -34,15 +34,16 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class OneEqFluxVariablesImpl;
/*!
* \ingroup OneEqModel
* \brief The flux variables class for the one-equation model by Spalart-Allmaras
* using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class OneEqFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class OneEqFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,15 +31,16 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class OneEqResidualImpl;
/*!
* \ingroup OneEqModel
* \brief Element-wise calculation of the residual for one-equation turbulence models
* using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class OneEqResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class OneEqResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -34,14 +34,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KEpsilonFluxVariablesImpl;
/*!
* \ingroup KEpsilonModel
* \brief The flux variables class for the k-epsilon model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KEpsilonFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class KEpsilonFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,14 +31,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KEpsilonResidualImpl;
/*!
* \ingroup KEpsilonModel
* \brief Element-wise calculation of the residual for k-epsilon models using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KEpsilonResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class KEpsilonResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -34,14 +34,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KOmegaFluxVariablesImpl;
/*!
* \ingroup KOmegaModel
* \brief The flux variables class for the k-omega model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KOmegaFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class KOmegaFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,14 +31,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KOmegaResidualImpl;
/*!
* \ingroup KOmegaModel
* \brief Element-wise calculation of the residual for k-omega models using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KOmegaResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class KOmegaResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -34,14 +34,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class LowReKEpsilonFluxVariablesImpl;
/*!
* \ingroup LowReKEpsilonModel
* \brief The flux variables class for the low-Reynolds k-epsilon model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class LowReKEpsilonFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class LowReKEpsilonFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,14 +31,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class LowReKEpsilonResidualImpl;
/*!
* \ingroup LowReKEpsilonModel
* \brief Element-wise calculation of the residual for low-Reynolds k-epsilon models using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class LowReKEpsilonResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class LowReKEpsilonResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
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