Skip to content
Snippets Groups Projects
Commit 36b46169 authored by andy's avatar andy
Browse files

ENH: Boundary condition doxygen documentation updates

parent b09f2a64
No related branches found
No related tags found
No related merge requests found
Showing
with 257 additions and 52 deletions
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,7 +25,30 @@ Class ...@@ -25,7 +25,30 @@ Class
Foam::mixedFvPatchField Foam::mixedFvPatchField
Description Description
Foam::mixedFvPatchField This boundary condition provides a base class for 'mixed' type boundary
conditions, i.e. conditions that mix fixed value and patch-normal gradient
conditions.
The respective contributions from each is determined by a weight field:
\f[
x_p = w*A + (1-w)*(x_c + B/delta)
\f]
where
\var x_p = patch values
\var x_c = patch internal cell values
\var w = weight field, \c valueFraction_
\var A = fixed value, \c refValue_
\var B = patch normal gradient, \c refGrad_
\var delta = inverse distance from face centre to internal cell centre
\note
This condition is not usually applied directly; instead, use a derived
mixed condition such as \c inletOutlet
SeeAlso
Foam::inletOutletFvPatchField
SourceFiles SourceFiles
mixedFvPatchField.C mixedFvPatchField.C
...@@ -43,7 +66,7 @@ namespace Foam ...@@ -43,7 +66,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class mixedFvPatch Declaration Class mixedFvPatchField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
template<class Type> template<class Type>
......
...@@ -25,7 +25,11 @@ Class ...@@ -25,7 +25,11 @@ Class
Foam::jumpCyclicFvPatchField Foam::jumpCyclicFvPatchField
Description Description
Foam::jumpCyclicFvPatchField This boundary condition provides a base class for coupled-cyclic
conditions with a specified 'jump' (or offset) between the values
SeeAlso
Foam::cyclicFvPatchField
SourceFiles SourceFiles
jumpCyclicFvPatchField.C jumpCyclicFvPatchField.C
...@@ -43,7 +47,7 @@ namespace Foam ...@@ -43,7 +47,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class cyclicFvPatch Declaration Class jumpCyclicFvPatchField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
template<class Type> template<class Type>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,7 +25,29 @@ Class ...@@ -25,7 +25,29 @@ Class
Foam::inletOutletFvPatchField Foam::inletOutletFvPatchField
Description Description
Foam::inletOutletFvPatchField This boundary condition provides a generic outflow condition, with
specified inflow for the case of return flow.
Example of the boundary condition specification:
\verbatim
myPatch
{
type inletOutlet;
phi phi; // name of flux field (default = phi)
inletValue uniform 0; // reverse flow (inlet) value
value uniform 0; // initial value
}
\endverbatim
The mode of operation is determined by the sign of the flux across the
patch faces.
\li positive flux (out of domain): apply zero-gradient condition
\li negative flux (into of domain): apply the user-specified fixed value
SeeAlso
Foam::mixedFvPatchField
Foam::zeroGradientFvPatchField
SourceFiles SourceFiles
inletOutletFvPatchField.C inletOutletFvPatchField.C
...@@ -43,7 +65,7 @@ namespace Foam ...@@ -43,7 +65,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class inletOutletFvPatch Declaration Class inletOutletFvPatchField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
template<class Type> template<class Type>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,7 +25,27 @@ Class ...@@ -25,7 +25,27 @@ Class
Foam::inletOutletTotalTemperatureFvPatchScalarField Foam::inletOutletTotalTemperatureFvPatchScalarField
Description Description
Foam::inletOutletTotalTemperatureFvPatchScalarField This boundary condition provides an outflow condition for total
temperature for use with supersonic cases, where a user-specified
value is applied in the case of reverse flow.
Example of the boundary condition specification:
\verbatim
myPatch
{
type inletOutletTotalTemperature;
U U; // velocity field (default = U)
phi phi; // flux field (default = phi)
psi psi; // compressiblility field (default = psi)
gamma gamma; // heat capacity ratio
inletValue uniform 0; // reverse flow (inlet) value
T0 uniform 0; // static temperature [K]
value uniform 0; // initial value
}
\endverbatim
SeeAlso
Foam::inletOutletFvPatchField
SourceFiles SourceFiles
inletOutletTotalTemperatureFvPatchScalarField.C inletOutletTotalTemperatureFvPatchScalarField.C
...@@ -43,7 +63,7 @@ namespace Foam ...@@ -43,7 +63,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class inletOutletTotalTemperatureFvPatch Declaration Class inletOutletTotalTemperatureFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
class inletOutletTotalTemperatureFvPatchScalarField class inletOutletTotalTemperatureFvPatchScalarField
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,10 +25,35 @@ Class ...@@ -25,10 +25,35 @@ Class
Foam::mappedFieldFvPatchField Foam::mappedFieldFvPatchField
Description Description
Self-contained version of mapped. Does not use information on This boundary condition provides a self-contained version of the \c mapped
patch, instead holds it locally (and possibly duplicate) so use condition. It does not use information on the patch; instead it holds
normal mapped in preference and only use this if you cannot thr data locally.
change the underlying patch type to mapped.
Example of the boundary condition specification:
\verbatim
myPatch
{
type mappedField;
fieldName T; // optional field name
setAverage no; // apply an average value
average 0; // average to apply if setAverage
value uniform 0; // place holder
}
\endverbatim
\note
Since this condition can be applied on a per-field and per-patch basis,
it is possible to duplicate the mapping information. If possible, employ
the \c mapped condition in preference to avoid this situation, and only
employ this condition if it is not possible to change the underlying
geometric (poly) patch type to \c mapped.
SeeAlso
Foam::mappedPatchBase
Foam::mappedPolyPatch
Foam::mappedFvPatch
Foam::fixedValueFvPatchField
SourceFiles SourceFiles
mappedFieldFvPatchField.C mappedFieldFvPatchField.C
...@@ -48,7 +73,7 @@ namespace Foam ...@@ -48,7 +73,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class mappedFieldFvPatchField Declaration Class mappedFieldFvPatchField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
template<class Type> template<class Type>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,8 +25,29 @@ Class ...@@ -25,8 +25,29 @@ Class
Foam::mappedFixedInternalValueFvPatchField Foam::mappedFixedInternalValueFvPatchField
Description Description
Recycles the boundary and internal values of a neighbour patch field to This boundary condition maps the boundary and internal values of a
the boundary and internal values of *this. neighbour patch field to the boundary and internal values of *this.
\verbatim
myPatch
{
type mappedFixedInternalValue;
fieldName T; // optional field name
setAverage no; // apply an average value
average 0; // average to apply if setAverage
value uniform 0; // place holder
}
\endverbatim
\note
This boundary condition can only be applied to patches that are of
the \c mappedPolyPatch type.
SeeAlso
Foam::mappedPatchBase
Foam::mappedPolyPatch
Foam::mappedFvPatch
Foam::mappedFixedValueFvPatchField
SourceFiles SourceFiles
mappedFixedInternalValueFvPatchField.C mappedFixedInternalValueFvPatchField.C
...@@ -44,7 +65,7 @@ namespace Foam ...@@ -44,7 +65,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class mappedFixedInternalValueFvPatchField Declaration Class mappedFixedInternalValueFvPatchField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
template<class Type> template<class Type>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,8 +25,30 @@ Class ...@@ -25,8 +25,30 @@ Class
Foam::mappedFixedPushedInternalValueFvPatchField Foam::mappedFixedPushedInternalValueFvPatchField
Description Description
Recycles the boundary values of a neighbour patch field to the boundary This boundary condition maps the boundary values of a neighbour patch
and internal values of *this. field to the boundary and internal cell values of *this.
Example of the boundary condition specification:
\verbatim
myPatch
{
type mappedFixedInternalValue;
fieldName T; // optional field name
setAverage no; // apply an average value
average 0; // average to apply if setAverage
value uniform 0; // place holder
}
\endverbatim
\note
This boundary condition can only be applied to patches that are of
the \c mappedPolyPatch type.
SeeAlso
Foam::mappedPatchBase
Foam::mappedPolyPatch
Foam::mappedFvPatch
Foam::mappedFixedValueFvPatchField
SourceFiles SourceFiles
mappedFixedPushedInternalValueFvPatchField.C mappedFixedPushedInternalValueFvPatchField.C
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,26 +25,41 @@ Class ...@@ -25,26 +25,41 @@ Class
Foam::mappedFixedValueFvPatchField Foam::mappedFixedValueFvPatchField
Description Description
Recycles the value at a set of cells or patch faces back to *this. Can not This boundary condition maps the value at a set of cells or patch faces
sample internal faces (since volField not defined on faces). back to *this.
The sample mode is set by the underlying mapping engine, provided by the
mappedPatchBase class.
Example of the boundary condition specification:
\verbatim
myPatch
{
type mapped;
fieldName T; // optional (alternative) field name
setAverage no; // apply an average value
average 0; // average to apply if setAverage
interpolationScheme cell; // optional interpolation scheme
value uniform 0; // place holder
}
\endverbatim
mode = NEARESTCELL : sample nearest cell When employing the \c nearestCell sample mode, the user must also specify
mode = NEARESTPATCHFACE : sample nearest face on selected patch the interpolation scheme using the \c interpolationScheme entry.
mode = NEARESTFACE : sample nearest face on any patch. Note: does not
warn if nearest actually is on internal face!
mode = NEARESTPATCHFACEAMI : sample nearest face on selected patch
patches can be non-conformal - method uses AMI interpolation
For NEARESTCELL you have to provide an 'interpolationScheme' entry In case of interpolation (where scheme != cell) the limitation is that
which can be any one of the interpolation schemes (cell, cellPoint, etc.) there is only one value per cell. For example, if you have a cell with two
In case of interpolation (so scheme != cell) the limitation is that boundary faces and both faces sample into the cell, both faces will get the
there is only one value per cell. So e.g. if you have a cell with two same value.
boundary faces and both faces sample into the cell both faces will get
the same value.
See mappedPatchBase for options on sampling. \note
It is not possible to sample internal faces since volume fields are not
defined on faces.
Optional 'fieldName' entry to supply a different filename SeeAlso
Foam::mappedPatchBase
Foam::interpolation
Foam::fixedValueFvPatchField
SourceFiles SourceFiles
mappedFixedValueFvPatchField.C mappedFixedValueFvPatchField.C
...@@ -63,7 +78,7 @@ namespace Foam ...@@ -63,7 +78,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class mappedFixedValueFvPatch Declaration Class mappedFixedValueFvPatchField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
template<class Type> template<class Type>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,11 +25,30 @@ Class ...@@ -25,11 +25,30 @@ Class
Foam::mappedVelocityFluxFixedValueFvPatchField Foam::mappedVelocityFluxFixedValueFvPatchField
Description Description
Recycles the velocity and flux at a patch to this patch This boundary condition maps the velocity and flux from a neighbour patch
to this patch
mode = NEARESTPATCHFACE : sample nearest face on selected patch Example of the boundary condition specification:
mode = NEARESTFACE : sample nearest face on any patch. Note: does not \verbatim
warn if nearest actually is on internal face! myPatch
{
type mappedFixedInternalValue;
phi phi; // name of flux field (default = phi)
value uniform 0; // place holder
}
\endverbatim
The underlying sample mode should be set to nearestPatchFace or nearestFace
\note
This boundary condition can only be applied to patches that are of
the \c mappedPolyPatch type.
SeeAlso
Foam::mappedPatchBase
Foam::mappedPolyPatch
Foam::mappedFvPatch
Foam::fixedValueFvPatchVectorField
SourceFiles SourceFiles
mappedVelocityFluxFixedValueFvPatchField.C mappedVelocityFluxFixedValueFvPatchField.C
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -25,7 +25,23 @@ Class ...@@ -25,7 +25,23 @@ Class
Foam::movingWallVelocityFvPatchVectorField Foam::movingWallVelocityFvPatchVectorField
Description Description
Foam::movingWallVelocityFvPatchVectorField This boundary condition provides a velocity condition for cases with
moving walls. In addition, it should also be applied to 'moving' walls
for moving reference frame (MRF) calculations.
Example of the boundary condition specification:
\verbatim
myPatch
{
type movingWallVelocity;
U U; // name of velocity field (default = U)
value uniform 0; // initial value
}
\endverbatim
SeeAlso
Foam::fixedValueFvPatchVectorField
Foam::MRFZone
SourceFiles SourceFiles
movingWallVelocityFvPatchVectorField.C movingWallVelocityFvPatchVectorField.C
...@@ -44,7 +60,7 @@ namespace Foam ...@@ -44,7 +60,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class movingWallVelocityFvPatch Declaration Class movingWallVelocityFvPatchVectorField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
class movingWallVelocityFvPatchVectorField class movingWallVelocityFvPatchVectorField
...@@ -125,7 +141,6 @@ public: ...@@ -125,7 +141,6 @@ public:
} }
// Member functions // Member functions
//- Update the coefficients associated with the patch field //- Update the coefficients associated with the patch field
......
...@@ -42,6 +42,7 @@ Description ...@@ -42,6 +42,7 @@ Description
\endverbatim \endverbatim
SeeAlso SeeAlso
Foam::radiation::radiationModel
Foam::radiation::fvDOM Foam::radiation::fvDOM
Foam::radiationCoupledBase Foam::radiationCoupledBase
Foam::mixedFvPatchField Foam::mixedFvPatchField
......
...@@ -25,7 +25,25 @@ Class ...@@ -25,7 +25,25 @@ Class
Foam::greyDiffusiveViewFactorFixedValueFvPatchScalarField Foam::greyDiffusiveViewFactorFixedValueFvPatchScalarField
Description Description
Radiation temperature specified This boundary condition provides a grey-diffuse condition for radiative
heat flux, \c Qr, for use with the view factor model
Example of the boundary condition specification:
\verbatim
myPatch
{
type greyDiffusiveRadiationViewFactor;
Qro uniform 0; // external radiative heat flux
emissivityMode solidThermo; // solidThermo | lookup
value uniform 0; // initial value
}
\endverbatim
SeeAlso
Foam::radiation::radiationModel
Foam::radiation::viewFactor
Foam::radiationCoupledBase
Foam::fixedValueFvPatchField
SourceFiles SourceFiles
greyDiffusiveViewFactorFixedValueFvPatchScalarField.C greyDiffusiveViewFactorFixedValueFvPatchScalarField.C
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment