Commit 04f044c1 authored by andy's avatar andy
Browse files

ENH: Boundary condition doxygen documentation updates

parent fa7053bd
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::basicSymmetryFvPatchField
......@@ -30,6 +33,8 @@ Description
SourceFiles
basicSymmetryFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef basicSymmetryFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::calculatedFvPatchField
......@@ -29,18 +32,22 @@ Description
that the value is assigned via field assignment, and not via a call to
e.g. \c updateCoeffs or \c evaluate.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type calculated;
value uniform (0 0 0); // optional value entry
}
myPatch
{
type calculated;
value uniform (0 0 0); // optional value entry
}
\endverbatim
SourceFiles
calculatedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef calculatedFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::coupledFvPatchField
......@@ -30,6 +33,8 @@ Description
SourceFiles
coupledFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef coupledFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::directionMixedFvPatchField
......@@ -30,6 +33,8 @@ Description
SourceFiles
directionMixedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef directionMixedFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::fixedGradientFvPatchField
......@@ -33,23 +36,34 @@ Description
\f]
where
\var values = patch values
\var int = internal field values
\var gradient = gradient (user-specified)
\var delta = inverse distance from patch face centre to cell centre
/vartable
values | patch values
int | internal field values
gradient | gradient (user-specified)
delta | inverse distance from patch face centre to cell centre
/endvartable
/heading Patch usage
/table
Property | Description | Required | Default value
gradient | gradient | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type fixedGradient;
gradient uniform 0;
}
myPatch
{
type fixedGradient;
gradient uniform 0;
}
\endverbatim
SourceFiles
fixedGradientFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef fixedGradientFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::fixedValueFvPatchField
......@@ -28,18 +31,27 @@ Description
This boundary condition supplies a fixed value constraint, and is the base
class for a number of other boundary conditions.
/heading Patch usage
/table
Property | Description | Required | Default value
value | values | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type fixedValue;
value uniform 0; // example for scalar field usage
}
myPatch
{
type fixedValue;
value uniform 0; // example for scalar field usage
}
\endverbatim
SourceFiles
fixedValueFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef fixedValueFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::mixedFvPatchField
......@@ -36,12 +39,14 @@ Description
\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
/vartable
x_p | patch values
x_c | patch internal cell values
w | weight field, \c valueFraction_
A | fixed value, \c refValue_
B | patch normal gradient, \c refGrad_
delta | inverse distance from face centre to internal cell centre
/endvartable
\note
This condition is not usually applied directly; instead, use a derived
......@@ -53,6 +58,8 @@ SeeAlso
SourceFiles
mixedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef mixedFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::slicedFvPatchField
......@@ -33,9 +36,14 @@ Description
Should only used as a template argument for SlicedGeometricField.
SeeAlso
Foam::fvPatchField
SourceFiles
slicedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef slicedFvPatchField_H
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::transformFvPatchField
......@@ -30,6 +33,8 @@ Description
SourceFiles
transformFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef transformFvPatchField_H
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,14 +21,29 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::zeroGradientFvPatchField
Description
Foam::zeroGradientFvPatchField
This boundary condition appies a zero-gradient condition from the patch
internal field onto the patch faces.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type zeroGradient;
}
\endverbatim
SourceFiles
zeroGradientFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
......@@ -43,7 +58,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class zeroGradientFvPatch Declaration
Class zeroGradientFvPatch Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::cyclicFvPatchField
......@@ -33,17 +36,21 @@ Description
transformed to the neighbour patch, the patches should be identical (or
very similar).
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type cyclic;
}
myPatch
{
type cyclic;
}
\endverbatim
SourceFiles
cyclicFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef cyclicFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::cyclicAMIFvPatchField
......@@ -34,17 +37,24 @@ Description
patch is transformed to the neighbour patch, the outer perimiter of each
patch should be identical (or very similar).
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type cyclicAMI;
}
myPatch
{
type cyclicAMI;
}
\endverbatim
SeeAlso
Foam::AMIInterpolation
SourceFiles
cyclicAMIFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef cyclicAMIFvPatchField_H
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::cyclicSlipFvPatchField
......@@ -28,12 +31,14 @@ Description
This boundary condition is a light wrapper around the cyclicFvPatchField
condition, providing no new functionality.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type cyclicSlip;
}
myPatch
{
type cyclicSlip;
}
\endverbatim
SeeAlso
......@@ -42,6 +47,8 @@ SeeAlso
SourceFiles
cyclicSlipFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef cyclicSlipFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::emptyFvPatchField
......@@ -30,17 +33,21 @@ Description
patches whose normal is aligned to geometric directions that do not
constitue solution directions.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type empty;
}
myPatch
{
type empty;
}
\endverbatim
SourceFiles
emptyFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef emptyFvPatchField_H
......
......@@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::jumpCyclicFvPatchField
......@@ -34,6 +37,8 @@ SeeAlso
SourceFiles
jumpCyclicFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef jumpCyclicFvPatchField_H
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,14 +21,23 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::nonuniformTransformCyclicFvPatchField
Description
Foam::nonuniformTransformCyclicFvPatchField
This boundary condition enforces a cyclic condition between a pair of
boundaries, incorporating a non-uniform transformation.
SourceFiles
nonuniformTransformCyclicFvPatchField.C
nonuniformTransformCyclicFvPatchFields.H
nonuniformTransformCyclicFvPatchFields.C
nonuniformTransformCyclicFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,15 +21,30 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup boundaryConditions
@{
Class
Foam::processorFvPatchField
Description
Foam::processorFvPatchField
This boundary condition enables processor communication across patches.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type processor;
}
\endverbatim
SourceFiles
processorFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef processorFvPatchField_H
......@@ -45,7 +60,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class processorFvPatch Declaration
Class processorFvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
......
......@@ -21,14 +21,36 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.