mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Doxygen documentation updates for module support
This commit is contained in:
Andrew Heather
@ -28,10 +28,11 @@ Group
|
||||
grpInletletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
|
||||
This velocity inlet/outlet boundary condition combines a fixed normal
|
||||
component obtained from the "normalVelocity" patchField supplied with a
|
||||
fixed or zero-gradiented tangential component depending on the direction
|
||||
fixed or zero-gradiented tangential component.
|
||||
|
||||
The tangential component is set depending on the direction
|
||||
of the flow and the setting of "fixTangentialInflow":
|
||||
- Outflow: apply zero-gradient condition to tangential components
|
||||
- Inflow:
|
||||
@ -64,9 +65,9 @@ Description
|
||||
offset (0 -1 0);
|
||||
amplitude table
|
||||
(
|
||||
( 0 0)
|
||||
( 2 0.088)
|
||||
( 8 0.088)
|
||||
(0 0)
|
||||
(2 0.088)
|
||||
(8 0.088)
|
||||
);
|
||||
frequency constant 1;
|
||||
}
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::boundedConvectionScheme
|
||||
|
||||
Group
|
||||
grpFvConvectionSchemes
|
||||
|
||||
Description
|
||||
Bounded form of the selected convection scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::convectionScheme
|
||||
|
||||
Group
|
||||
grpFvConvectionSchemes
|
||||
|
||||
Description
|
||||
Abstract base class for convection schemes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::gaussConvectionScheme
|
||||
|
||||
Group
|
||||
grpFvConvectionSchemes
|
||||
|
||||
Description
|
||||
Basic second-order convection using face-gradients and Gauss' theorem.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::multivariateGaussConvectionScheme
|
||||
|
||||
Group
|
||||
grpFvConvectionSchemes
|
||||
|
||||
Description
|
||||
Basic second-order convection using face-gradients and Gauss' theorem.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::CoEulerDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Courant number limited first-order Euler implicit/explicit ddt.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::CrankNicolsonDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Second-oder Crank-Nicolson implicit ddt using the current and
|
||||
previous time-step fields as well as the previous time-step ddt.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::EulerDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Basic first-order Euler implicit/explicit ddt using only the current and
|
||||
previous time-step values.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::SLTSDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Stabilised local time-step first-order Euler implicit/explicit ddt.
|
||||
The time-step is adjusted locally so that an advective equations remains
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::backwardDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Second-order backward-differencing ddt using the current and
|
||||
two previous time-step values.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::boundedDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Bounded form of the selected ddt scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::ddtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Abstract base class for ddt schemes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::localEulerDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
Local time-step first-order Euler implicit/explicit ddt.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::steadyStateDdtScheme
|
||||
|
||||
Group
|
||||
grpFvDdtSchemes
|
||||
|
||||
Description
|
||||
SteadyState implicit/explicit ddt which returns 0.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::divScheme
|
||||
|
||||
Group
|
||||
grpFvDivSchemes
|
||||
|
||||
Description
|
||||
Abstract base class for div schemes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::gaussDivScheme
|
||||
|
||||
Group
|
||||
grpFvDivSchemes
|
||||
|
||||
Description
|
||||
Basic second-order div using face-gradients and Gauss' theorem.
|
||||
|
||||
|
||||
80
src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H
Normal file
80
src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H
Normal file
@ -0,0 +1,80 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
This file is part of OpenFOAM.
|
||||
|
||||
OpenFOAM is free software: you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License as published by the Free
|
||||
Software Foundation, either version 3 of the License, or (at your option)
|
||||
any later version.
|
||||
|
||||
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with
|
||||
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpFvSchemes Finite volume numerical schemes
|
||||
@{
|
||||
This group contains finite volume numerical schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvGradSchemes Gradient schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume gradient schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvSnGradSchemes Surface normal gradient schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume surface normal gradient schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvDivSchemes Divergence schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume divergence schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvLaplacianSchemes Laplacian schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume Laplacian schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvDdtSchemes Time schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume time schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvConvectionSchemes Convection schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume convection schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvSurfaceInterpolationSchemes Surface interpolation schemes
|
||||
@{
|
||||
\ingroup grpFvSchemes
|
||||
This group contains finite volume surface interpolation schemes
|
||||
@}
|
||||
|
||||
\defgroup grpFvLimitedSurfaceInterpolationSchemes Limited interpolation schemes
|
||||
@{
|
||||
\ingroup grpFvSurfaceInterpolationSchemes
|
||||
This group contains finite volume limited surface interpolation schemes
|
||||
@}
|
||||
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::LeastSquaresGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
Gradient calculated using weighted least-squares on an arbitrary stencil.
|
||||
The stencil type is provided via a template argument and any cell-based
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::fourthGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
Second-order gradient scheme using least-squares.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::gaussGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
Basic second-order gradient scheme using face-interpolation
|
||||
and Gauss' theorem.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::leastSquaresGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
Second-order gradient scheme using least-squares.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::cellLimitedGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
cellLimitedGrad gradient scheme applied to a runTime selected base gradient
|
||||
scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::cellMDLimitedGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
cellMDLimitedGrad gradient scheme applied to a runTime selected base
|
||||
gradient scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::faceLimitedGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
faceLimitedGrad gradient scheme applied to a runTime selected base gradient
|
||||
scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::faceMDLimitedGrad
|
||||
|
||||
Group
|
||||
grpFvGradSchemes
|
||||
|
||||
Description
|
||||
faceMDLimitedGrad gradient scheme applied to a runTime selected
|
||||
base gradient scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::gaussLaplacianScheme
|
||||
|
||||
Group
|
||||
grpFvLaplacianSchemes
|
||||
|
||||
Description
|
||||
Basic second-order laplacian using face-gradients and Gauss' theorem.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::laplacianScheme
|
||||
|
||||
Group
|
||||
grpFvLaplacianSchemes
|
||||
|
||||
Description
|
||||
Abstract base class for laplacian schemes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::CentredFitSnGradScheme
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Centred fit snGrad scheme which applies an explicit correction to snGrad
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::correctedSnGrad
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Simple central-difference snGrad scheme with non-orthogonal correction.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::faceCorrectedSnGrad
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Simple central-difference snGrad scheme with non-orthogonal correction.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::limitedSnGrad
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Run-time selected snGrad scheme with limited non-orthogonal correction.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::orthogonalSnGrad
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Simple central-difference snGrad scheme without non-orthogonal correction.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::snGradScheme
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Abstract base class for snGrad schemes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fv::uncorrectedSnGrad
|
||||
|
||||
Group
|
||||
grpFvSnGradSchemes
|
||||
|
||||
Description
|
||||
Simple central-difference snGrad scheme without non-orthogonal correction.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::GammaLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
Gamma differencing scheme based on phict obtained from the LimiterFunc
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::LimitedLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Foam::LimitedLimiter
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::Limited01Limiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
A LimitedLimiter with the range 0-1
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::LimitedScheme
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class to create NVD/TVD limited weighting-factors.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::MUSCLLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
van Leer's MUSCL differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::MinmodLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
Minmod differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::OSPRELimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
OSPRE differencing scheme based on r obtained from the LimiterFunc
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::PhiLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
Phi differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::PhiScheme
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class to create the weighting-factors based on the face-flux.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::QUICKLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
quadratic-upwind differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::SFCDLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
SFCD differencing scheme based on phict obtained from the LimiterFunc
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::SuperBeeLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
SuperBee differencing scheme based on r obtained from the LimiterFunc
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::UMISTLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
UMIST differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::blended
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
linear/upwind blended differencing scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::filteredLinearLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class to generate weighting factors for the filteredLinear
|
||||
differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::filteredLinear2Limiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class to generate weighting factors for the filteredLinear2
|
||||
differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::filteredLinear3Limiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class to generate weighting factors for the filteredLinear
|
||||
differencing scheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::limitWith
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
limitWith differencing scheme limits the specified scheme with the
|
||||
specified limiter.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::limitedCubicLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
TVD limited centred-cubic differencing scheme based on r obtained from
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::limitedLinearLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
TVD limited linear differencing scheme based on r obtained from the
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::limitedSurfaceInterpolationScheme
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Abstract base class for limited surface interpolation schemes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::upwind
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Upwind differencing scheme class.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::vanAlbadaLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
vanAlbada differencing scheme based on r obtained from the LimiterFunc
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::vanLeerLimiter
|
||||
|
||||
Group
|
||||
grpFvLimitedSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Class with limiter function which returns the limiter for the
|
||||
vanLeer differencing scheme based on r obtained from the LimiterFunc
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::CentredFitScheme
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Centred fit surface interpolation scheme which applies an explicit
|
||||
correction to linear.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::CoBlended
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Two-scheme Courant number based blending differencing scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::LUST
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
LUST: Linear-upwind stabilised transport.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::PureUpwindFitScheme
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Upwind biased fit surface interpolation scheme that applies an explicit
|
||||
correction to upwind.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::UpwindFitScheme
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Upwind biased fit surface interpolation scheme that applies an explicit
|
||||
correction to linear.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::cellCoBlended
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Two-scheme cell-based Courant number based blending differencing scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::clippedLinear
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Central-differencing interpolation scheme using clipped-weights to
|
||||
improve stability on meshes with very rapid variations in cell size.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::cubic
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Cubic interpolation scheme class derived from linear and returns
|
||||
linear weighting factors but also applies an explicit correction.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::downwind
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Downwind differencing scheme class.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::fixedBlended
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Two-scheme fixed-blending differencing scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::harmonic
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Harmonic-mean differencing scheme class.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::limiterBlended
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Blends two specified schemes using the limiter function provided by a
|
||||
limitedSurfaceInterpolationScheme.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::linear
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Central-differencing interpolation scheme class
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::linearUpwind
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
linearUpwind interpolation scheme class derived from upwind and returns
|
||||
upwind weighting factors and also applies a gradient-based explicit
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::localBlended
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Two-scheme localBlended differencing scheme.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::localMax
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
LocalMax-mean differencing scheme class.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::localMin
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
LocalMin-mean differencing scheme class.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::midPoint
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Mid-point interpolation (weighting factors = 0.5) scheme class.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::outletStabilised
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Outlet-stabilised interpolation scheme which applies upwind differencing
|
||||
to the faces of the cells adjacent to outlets.
|
||||
@ -53,7 +56,7 @@ namespace Foam
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class outletStabilised Declaration
|
||||
Class outletStabilised Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
template<class Type>
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::pointLinear
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Face-point interpolation scheme class derived from linear and
|
||||
returns linear weighting factors but also applies an explicit correction.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::reverseLinear
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Inversed weight central-differencing interpolation scheme class.
|
||||
|
||||
@ -46,7 +49,7 @@ namespace Foam
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class reverseLinear Declaration
|
||||
Class reverseLinear Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
template<class Type>
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::skewCorrected
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Skewness-corrected interpolation scheme that applies an explicit
|
||||
correction to given scheme.
|
||||
@ -47,7 +50,7 @@ namespace Foam
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class skewCorrected Declaration
|
||||
Class skewCorrected Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
template<class Type>
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::weighted
|
||||
|
||||
Group
|
||||
grpFvSurfaceInterpolationSchemes
|
||||
|
||||
Description
|
||||
Interpolation scheme class using weights looked-up from the objectRegistry.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::COxidationDiffusionLimitedRate
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateSurfaceReactionSubModels
|
||||
|
||||
Description
|
||||
Diffusion limited rate surface reaction model for coal parcels. Limited to:
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::COxidationHurtMitchell
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateSurfaceReactionSubModels
|
||||
|
||||
Description
|
||||
Char oxidation model given by Hurt and Mitchell:
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::COxidationIntrinsicRate
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateSurfaceReactionSubModels
|
||||
|
||||
Description
|
||||
Intrinsic char surface reaction mndel
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::COxidationKineticDiffusionLimitedRate
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateSurfaceReactionSubModels
|
||||
|
||||
Description
|
||||
Kinetic/diffusion limited rate surface reaction model for coal parcels.
|
||||
Limited to:
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::COxidationMurphyShaddix
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateSurfaceReactionSubModels
|
||||
|
||||
Description
|
||||
Limited to C(s) + O2 -> CO2
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::CollidingCloud
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateClouds
|
||||
|
||||
Description
|
||||
Adds coolisions to kinematic clouds
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::KinematicCloud
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateClouds
|
||||
|
||||
Description
|
||||
Templated base class for kinematic cloud
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::MPPICCloud
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateClouds
|
||||
|
||||
Description
|
||||
Adds MPPIC modelling to kinematic clouds
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ReactingCloud
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateClouds
|
||||
|
||||
Description
|
||||
Templated base class for reacting cloud
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ReactingMultiphaseCloud
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateClouds
|
||||
|
||||
Description
|
||||
Templated base class for multiphase reacting cloud
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ThermoCloud
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateClouds
|
||||
|
||||
Description
|
||||
Templated base class for thermodynamic cloud
|
||||
|
||||
|
||||
220
src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H
Normal file
220
src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H
Normal file
@ -0,0 +1,220 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
This file is part of OpenFOAM.
|
||||
|
||||
OpenFOAM is free software: you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License as published by the Free
|
||||
Software Foundation, either version 3 of the License, or (at your option)
|
||||
any later version.
|
||||
|
||||
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with
|
||||
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpLagrangianIntermediate Lagrangian particle modelling
|
||||
@{
|
||||
This group contains Lagrangian modelling available in the 'intermediate' library
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateClouds Clouds
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediate
|
||||
This group contains Lagrangian clouds
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateParcels Parcels
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediate
|
||||
This group contains Lagrangian parcels
|
||||
@}
|
||||
|
||||
// Submodels
|
||||
\defgroup grpLagrangianIntermediateSubModels Submodels
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediate
|
||||
This group contains Lagrangian parcel submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateKinematicSubModels Kinematic
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateSubModels
|
||||
This group contains Lagrangian kinematic parcel submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateThermoSubModels Thermodynamic
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateSubModels
|
||||
This group contains Lagrangian thermo parcel submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateReactingSubModels Reacting
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateSubModels
|
||||
This group contains Lagrangian reacting parcel submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateReactingMultiphaseSubModels Reacting multiphase
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateSubModels
|
||||
This group contains Lagrangian reacting multiphase parcel submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICSubModels MP-PIC
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateSubModels
|
||||
This group contains Lagrangian MP-PIC parcel submodels
|
||||
@}
|
||||
|
||||
|
||||
// Kinematic parcel sub models
|
||||
\defgroup grpLagrangianIntermediateCollisionSubModels Collision
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateKinematicSubModels
|
||||
This group contains Lagrangian particle collision submodes
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateDispersionSubModels Dispersion
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateKinematicSubModels
|
||||
This group contains Lagrangian particle dispersion submodes
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateInjectionSubModels Injection
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateKinematicSubModels
|
||||
This group contains Lagrangian particle injection submodes
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateForceSubModels Forces
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateKinematicSubModels
|
||||
This group contains Lagrangian particle force submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediatePatchInteractionSubModels Patch interaction
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateKinematicSubModels
|
||||
This group contains Lagrangian particle patch interaction submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateSurfaceFilmSubModels Surface film
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateKinematicSubModels
|
||||
This group contains Lagrangian particle patch interaction submodels
|
||||
@}
|
||||
|
||||
|
||||
// Thermo parcel submodels
|
||||
\defgroup grpLagrangianIntermediateHeatTransferSubModels Heat transfer
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateThermoSubModels
|
||||
This group contains Lagrangian particle heat transfer submodels
|
||||
@}
|
||||
|
||||
|
||||
// Reacting parcel submodels
|
||||
\defgroup grpLagrangianIntermediateCompositionSubModels Composition
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateReactingSubModels
|
||||
This group contains Lagrangian particle composition submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediatePhaseChangeSubModels Phase change
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateReactingSubModels
|
||||
This group contains Lagrangian particle phase change submodels
|
||||
@}
|
||||
|
||||
// Spray parcel submodels (Spray derived from Reacting)
|
||||
\defgroup grpLagrangianIntermediateAtomizationSubModels Atomization
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateReactingSubModels
|
||||
This group contains Lagrangian particle atomization submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateBreakupSubModels Breakup
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateReactingSubModels
|
||||
This group contains Lagrangian particle breakup submodels
|
||||
@}
|
||||
|
||||
|
||||
// Reacting multiphase parcel submodels
|
||||
\defgroup grpLagrangianIntermediateDevolatilisationSubModels Devolatilisation
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateReactingMultiphaseSubModels
|
||||
This group contains Lagrangian particle devolatilisation submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateSurfaceReactionSubModels Surface reaction
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateReactingMultiphaseSubModels
|
||||
This group contains Lagrangian particle surface reaction submodels
|
||||
@}
|
||||
|
||||
|
||||
// MP-PIC parcel submodels
|
||||
\defgroup grpLagrangianIntermediateMPPICAveragingMethods Averaging
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle averaging methods
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICCorrectionLimitingMethods Correction limiting
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle correction limiting methods
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICDampingSubModels Damping
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle damping submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICIsotropySubModels Isotropy
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle isotropy submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICPackingSubModels Packing
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle packing submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICParticleStressSubModels Particle stress
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle stress submodels
|
||||
@}
|
||||
|
||||
\defgroup grpLagrangianIntermediateMPPICTimeScaleSubModels Time scale
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateMPPICSubModels
|
||||
This group contains Lagrangian MP-PIC particle time scale submodels
|
||||
@}
|
||||
|
||||
|
||||
// Function objects
|
||||
\defgroup grpLagrangianIntermediateFunctionObjects Function objects
|
||||
@{
|
||||
\ingroup grpLagrangianIntermediateSubModels
|
||||
This group contains Lagrangian function objects
|
||||
@}
|
||||
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::CollidingParcel
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateParcels
|
||||
|
||||
Description
|
||||
Wrapper around kinematic parcel types to add collision modelling
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::KinematicParcel
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateParcels
|
||||
|
||||
Description
|
||||
Kinematic parcel class with rotational motion (as spherical
|
||||
particles only) and one/two-way coupling with the continuous
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::MPPICParcel
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateParcels
|
||||
|
||||
Description
|
||||
Wrapper around kinematic parcel types to add MPPIC modelling
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ReactingMultiphaseParcel
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateParcels
|
||||
|
||||
Description
|
||||
Multiphase variant of the reacting parcel class with one/two-way coupling
|
||||
with the continuous phase.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ReactingParcel
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateParcels
|
||||
|
||||
Description
|
||||
Reacting parcel class with one/two-way coupling with the continuous
|
||||
phase.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ThermoParcel
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateParcels
|
||||
|
||||
Description
|
||||
Thermodynamic parcel class with one/two-way coupling with the continuous
|
||||
phase. Includes Kinematic parcel sub-models, plus:
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::CloudFunctionObject
|
||||
|
||||
Group
|
||||
grpLagrangianIntermediateFunctionObjects
|
||||
|
||||
Description
|
||||
Templated cloud function object base class
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user