zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: doxygen documentation updates

Browse Source
This commit is contained in:
andy
2012-07-12 17:12:52 +01:00
parent c40bc965ed
commit a80d4d9b69
152 changed files with 1131 additions and 555 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H
View File

@ -21,6 +21,8 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\defgroup grpFunctionObjects Function objects \defgroup grpFunctionObjects Function objects
@{ @{
This group contains function objects This group contains function objects

28
src/OpenFOAM/global/foamDoc.H
View File

@ -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
@ -21,6 +21,8 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\mainpage OpenFOAM&reg;: open source CFD \mainpage OpenFOAM&reg;: open source CFD
\section about About OpenFOAM \section about About OpenFOAM
@ -34,4 +36,28 @@ License
turbulence and heat transfer, to solid dynamics and electromagnetics. turbulence and heat transfer, to solid dynamics and electromagnetics.
<a href="http://www.openfoam.org/features">More ...</a> <a href="http://www.openfoam.org/features">More ...</a>
\section layout Code Layout
The OpenFOAM source code comprises of four main components:
- src:
the core OpenFOAM source code
- applications:
collections of library functionality wrapped up into applications,
such as solvers and utilities
- tutorials:
a suite of test cases that highlight a broad cross-section of
OpenFOAM's capabilities
- doc:
supporting documentation
\section usingTheCode Using the code
- \subpage pagePostProcessing
- \subpage pageBoundaryConditions
- \subpage grpIcoRASBoundaryConditions
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

8
src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H
View File

@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::basicSymmetryFvPatchField Foam::basicSymmetryFvPatchField
Group
grpConstraintBoundaryConditions
Description Description
A symmetry patch A symmetry patch
SourceFiles SourceFiles
basicSymmetryFvPatchField.C basicSymmetryFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef basicSymmetryFvPatchField_H #ifndef basicSymmetryFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::calculatedFvPatchField Foam::calculatedFvPatchField
Group
grpGenericBoundaryConditions
Description Description
This boundary condition is not designed to be evaluated; it is assmued This boundary condition is not designed to be evaluated; it is assmued
that the value is assigned via field assignment, and not via a call to that the value is assigned via field assignment, and not via a call to
@ -46,8 +46,6 @@ Description
SourceFiles SourceFiles
calculatedFvPatchField.C calculatedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef calculatedFvPatchField_H #ifndef calculatedFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H
View File

@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::coupledFvPatchField Foam::coupledFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
Abstract base class for coupled patches. Abstract base class for coupled patches.
SourceFiles SourceFiles
coupledFvPatchField.C coupledFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef coupledFvPatchField_H #ifndef coupledFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H
View File

@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::directionMixedFvPatchField Foam::directionMixedFvPatchField
Group
grpGenericBoundaryConditions
Description Description
Base class for direction-mixed boundary conditions. Base class for direction-mixed boundary conditions.
SourceFiles SourceFiles
directionMixedFvPatchField.C directionMixedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef directionMixedFvPatchField_H #ifndef directionMixedFvPatchField_H

18
src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H
View File

@ -21,26 +21,26 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::fixedGradientFvPatchField Foam::fixedGradientFvPatchField
Group
grpGenericBoundaryConditions
Description Description
This boundary condition supplies a fixed gradient condition, such that This boundary condition supplies a fixed gradient condition, such that
the patch values are calculated using: the patch values are calculated using:
\f[ \f[
values = int + gradient/delta x_p = x_c + \frac{\nabla(x)}{\Delta}
\f] \f]
where where
/vartable /vartable
values | patch values x_p | patch values
int | internal field values x_c | internal field values
gradient | gradient (user-specified) \nabla(x)| gradient (user-specified)
delta | inverse distance from patch face centre to cell centre \Delta | inverse distance from patch face centre to cell centre
/endvartable /endvartable
/heading Patch usage /heading Patch usage
@ -62,8 +62,6 @@ Description
SourceFiles SourceFiles
fixedGradientFvPatchField.C fixedGradientFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef fixedGradientFvPatchField_H #ifndef fixedGradientFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
Group
grpGenericBoundaryConditions
Description Description
This boundary condition supplies a fixed value constraint, and is the base This boundary condition supplies a fixed value constraint, and is the base
class for a number of other boundary conditions. class for a number of other boundary conditions.
@ -50,8 +50,6 @@ Description
SourceFiles SourceFiles
fixedValueFvPatchField.C fixedValueFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef fixedValueFvPatchField_H #ifndef fixedValueFvPatchField_H

12
src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::mixedFvPatchField Foam::mixedFvPatchField
Group
grpGenericBoundaryConditions
Description Description
This boundary condition provides a base class for 'mixed' type boundary This boundary condition provides a base class for 'mixed' type boundary
conditions, i.e. conditions that mix fixed value and patch-normal gradient conditions, i.e. conditions that mix fixed value and patch-normal gradient
@ -35,7 +35,7 @@ Description
The respective contributions from each is determined by a weight field: The respective contributions from each is determined by a weight field:
\f[ \f[
x_p = w*A + (1-w)*(x_c + B/delta) x_p = w*A + (1-w)*(x_c + B/\Delta)
\f] \f]
where where
@ -45,7 +45,7 @@ Description
w | weight field, \c valueFraction_ w | weight field, \c valueFraction_
A | fixed value, \c refValue_ A | fixed value, \c refValue_
B | patch normal gradient, \c refGrad_ B | patch normal gradient, \c refGrad_
delta | inverse distance from face centre to internal cell centre \Delta| inverse distance from face centre to internal cell centre
/endvartable /endvartable
\note \note
@ -58,8 +58,6 @@ SeeAlso
SourceFiles SourceFiles
mixedFvPatchField.C mixedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef mixedFvPatchField_H #ifndef mixedFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::slicedFvPatchField Foam::slicedFvPatchField
Group
grpGenericBoundaryConditions
Description Description
Specialization of fvPatchField which creates the underlying Specialization of fvPatchField which creates the underlying
fvPatchField as a slice of the given complete field. fvPatchField as a slice of the given complete field.
@ -42,8 +42,6 @@ SeeAlso
SourceFiles SourceFiles
slicedFvPatchField.C slicedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef slicedFvPatchField_H #ifndef slicedFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H
View File

@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::transformFvPatchField Foam::transformFvPatchField
Group
grpGenericBoundaryConditions
Description Description
Foam::transformFvPatchField Foam::transformFvPatchField
SourceFiles SourceFiles
transformFvPatchField.C transformFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef transformFvPatchField_H #ifndef transformFvPatchField_H

7
src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::zeroGradientFvPatchField Foam::zeroGradientFvPatchField
Group
grpGenericBoundaryConditions
Description Description
This boundary condition appies a zero-gradient condition from the patch This boundary condition appies a zero-gradient condition from the patch
internal field onto the patch faces. internal field onto the patch faces.
@ -43,7 +43,6 @@ Description
SourceFiles SourceFiles
zeroGradientFvPatchField.C zeroGradientFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

8
src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::cyclicFvPatchField Foam::cyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition enforces a cyclic condition between a pair of This boundary condition enforces a cyclic condition between a pair of
boundaries. boundaries.
@ -49,8 +49,6 @@ Description
SourceFiles SourceFiles
cyclicFvPatchField.C cyclicFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef cyclicFvPatchField_H #ifndef cyclicFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::cyclicAMIFvPatchField Foam::cyclicAMIFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition enforces a cyclic condition between a pair of This boundary condition enforces a cyclic condition between a pair of
boundaries, whereby communication between the patches is performed using boundaries, whereby communication between the patches is performed using
@ -53,8 +53,6 @@ SeeAlso
SourceFiles SourceFiles
cyclicAMIFvPatchField.C cyclicAMIFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef cyclicAMIFvPatchField_H #ifndef cyclicAMIFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::cyclicSlipFvPatchField Foam::cyclicSlipFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition is a light wrapper around the cyclicFvPatchField This boundary condition is a light wrapper around the cyclicFvPatchField
condition, providing no new functionality. condition, providing no new functionality.
@ -47,8 +47,6 @@ SeeAlso
SourceFiles SourceFiles
cyclicSlipFvPatchField.C cyclicSlipFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef cyclicSlipFvPatchField_H #ifndef cyclicSlipFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::emptyFvPatchField Foam::emptyFvPatchField
Group
grpConstraintBoundaryConditions
Description Description
This boundary condition provides an 'empty' condition for reduced This boundary condition provides an 'empty' condition for reduced
dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to
@ -46,8 +46,6 @@ Description
SourceFiles SourceFiles
emptyFvPatchField.C emptyFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef emptyFvPatchField_H #ifndef emptyFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::jumpCyclicFvPatchField Foam::jumpCyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition provides a base class for coupled-cyclic This boundary condition provides a base class for coupled-cyclic
conditions with a specified 'jump' (or offset) between the values conditions with a specified 'jump' (or offset) between the values
@ -37,8 +37,6 @@ SeeAlso
SourceFiles SourceFiles
jumpCyclicFvPatchField.C jumpCyclicFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef jumpCyclicFvPatchField_H #ifndef jumpCyclicFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::nonuniformTransformCyclicFvPatchField Foam::nonuniformTransformCyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition enforces a cyclic condition between a pair of This boundary condition enforces a cyclic condition between a pair of
boundaries, incorporating a non-uniform transformation. boundaries, incorporating a non-uniform transformation.
@ -37,8 +37,6 @@ SourceFiles
nonuniformTransformCyclicFvPatchFields.C nonuniformTransformCyclicFvPatchFields.C
nonuniformTransformCyclicFvPatchFieldsFwd.H nonuniformTransformCyclicFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef nonuniformTransformCyclicFvPatchField_H #ifndef nonuniformTransformCyclicFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::processorFvPatchField Foam::processorFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition enables processor communication across patches. This boundary condition enables processor communication across patches.
@ -43,8 +43,6 @@ Description
SourceFiles SourceFiles
processorFvPatchField.C processorFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef processorFvPatchField_H #ifndef processorFvPatchField_H

8
src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::processorCyclicFvPatchField Foam::processorCyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description Description
This boundary condition enables processor communication across cyclic This boundary condition enables processor communication across cyclic
patches. patches.
@ -50,8 +50,6 @@ SourceFiles
processorCyclicFvPatchFields.C processorCyclicFvPatchFields.C
processorCyclicFvPatchFieldsFwd.H processorCyclicFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef processorCyclicFvPatchField_H #ifndef processorCyclicFvPatchField_H

7
src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::symmetryFvPatchField Foam::symmetryFvPatchField
Group
grpConstraintBoundaryConditions
Description Description
This boundary condition enforces a symmetry constraint This boundary condition enforces a symmetry constraint
@ -45,7 +45,6 @@ SourceFiles
symmetryFvPatchFields.C symmetryFvPatchFields.C
symmetryFvPatchFields.H symmetryFvPatchFields.H
symmetryFvPatchFieldsFwd.H symmetryFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

8
src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class Class
Foam::wedgeFvPatchField Foam::wedgeFvPatchField
Group
grpConstraintBoundaryConditions
Description Description
This boundary condition is similar to the cyclic condition, except that This boundary condition is similar to the cyclic condition, except that
it is applied to 2-D geometries. it is applied to 2-D geometries.
@ -47,8 +47,6 @@ SeeAlso
SourceFiles SourceFiles
wedgeFvPatchField.C wedgeFvPatchField.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef wedgeFvPatchField_H #ifndef wedgeFvPatchField_H

3
src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::activeBaffleVelocityFvPatchVectorField Foam::activeBaffleVelocityFvPatchVectorField
\ingroup grpCoupledBoundaryConditions Group
grpCoupledBoundaryConditions
Description Description
This velocity boundary condition simulates the opening of a baffle due This velocity boundary condition simulates the opening of a baffle due

3
src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::activePressureForceBaffleVelocityFvPatchVectorField Foam::activePressureForceBaffleVelocityFvPatchVectorField
\ingroup grpCoupledBoundaryConditions Group
grpCoupledBoundaryConditions
Description Description
This boundary condition is applied to the flow velocity, to simulate the This boundary condition is applied to the flow velocity, to simulate the

3
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::advectiveFvPatchField Foam::advectiveFvPatchField
\ingroup grpOutletBoundaryConditions Group
grpOutletBoundaryConditions
Description Description
This boundary condition provides an advective outflow condition, based on This boundary condition provides an advective outflow condition, based on

20
src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::buoyantPressureFvPatchScalarField Foam::buoyantPressureFvPatchScalarField
\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions Group
grpGenericBoundaryConditions grpWallBoundaryConditions
Description Description
This boundary condition sets the pressure gradient appropriately for This boundary condition sets the pressure gradient appropriately for
@ -34,31 +35,30 @@ Description
- \c pd - \c pd
- \c p_rgh - \c p_rgh
- \c ph_rgh - \c ph_rgh
we assume that the pressure variable is \f$p - rho*g.h\f$ and the gradient we assume that the pressure variable is \f$p - \rho(g \cdot h)\f$ and the
set using: gradient set using:
\f[ \f[
grad(pressure) = -snGrad(rho)*(g.h) \nabla(p) = -\nabla_\perp(\rho)(g \cdot h)
\f] \f]
where where
/vartable /vartable
snGrad | surface-normal gradient operator \rho | density [kg/m3]
rho | density [kg/m3]
g | acceleration due to gravity [m/s2] g | acceleration due to gravity [m/s2]
h | patch face centres [m] h | patch face centres [m]
/endtable /endvartable
Otherwise we assume that it is the static pressure, and the gradient Otherwise we assume that it is the static pressure, and the gradient
calculated using: calculated using:
\f[ \f[
grad(pressure) = rho*(g.n) \nabla(p) = \rho(g \cdot n)
\f] \f]
where where
/vartable /vartable
n | patch face normal vectors n | patch face normal vectors
/endtable /endvartable
/heading Patch usage /heading Patch usage
@ -94,7 +94,7 @@ namespace Foam
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class buoyantPressureFvPatch Declaration Class buoyantPressureFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
class buoyantPressureFvPatchScalarField class buoyantPressureFvPatchScalarField

3
src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::codedFixedValueFvPatchField Foam::codedFixedValueFvPatchField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
Constructs on-the-fly a new boundary condition (derived from Constructs on-the-fly a new boundary condition (derived from

3
src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::codedMixedFvPatchField Foam::codedMixedFvPatchField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
Constructs on-the-fly a new boundary condition (derived from Constructs on-the-fly a new boundary condition (derived from

3
src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::cylindricalInletVelocityFvPatchVectorField Foam::cylindricalInletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition describes an inlet vector boundary condition in This boundary condition describes an inlet vector boundary condition in

3
src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fanFvPatchField Foam::fanFvPatchField
\ingroup grpCoupledBoundaryConditions Group
grpCoupledBoundaryConditions
Description Description
This boundary condition supplies a jump condition, using the \c cyclic This boundary condition supplies a jump condition, using the \c cyclic

5
src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fanPressureFvPatchScalarField Foam::fanPressureFvPatchScalarField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition can be applied to assign either a pressure inlet This boundary condition can be applied to assign either a pressure inlet
@ -97,8 +98,10 @@ public:
ffdOut ffdOut
}; };
//- Fan flow directions names
static const NamedEnum<fanFlowDirection, 2> fanFlowDirectionNames_; static const NamedEnum<fanFlowDirection, 2> fanFlowDirectionNames_;
private: private:
// Private data // Private data

13
src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H
View File

@ -24,23 +24,26 @@ License
Class Class
Foam::fixedFluxPressureFvPatchScalarField Foam::fixedFluxPressureFvPatchScalarField
\ingroup grpBoundaryConditions Group
grpOutletBoundaryConditions
Description Description
This boundary condition adjusts the pressure gradient such that the flux This boundary condition adjusts the pressure gradient such that the flux
on the boundary is that specified by the velocity boundary condition. on the boundary is that specified by the velocity boundary condition.
The predicted flux to be compensated by the pressure gradient is evaluated The predicted flux to be compensated by the pressure gradient is evaluated
as \f$(phi - phiHbyA)\f$, both of which are looked-up from the database, as as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as
is the pressure diffusivity \c Dp used to calculate the gradient using: is the pressure diffusivity used to calculate the gradient using:
\f[ \f[
grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} \nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| D_p}
\f] \f]
where where
/vartable /vartable
phi | flux
D_p | pressure diffusivity
Sf | patch face areas [m2] Sf | patch face areas [m2]
/endvartable /endvartable
@ -58,7 +61,7 @@ Description
\verbatim \verbatim
myPatch myPatch
{ {
type externalWallHeatFluxTemperature; type fixedFluxPressure;
phiHbyA phiHbyA; phiHbyA phiHbyA;
phi phi; phi phi;
rho rho; rho rho;

3
src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fixedInternalValueFvPatchField Foam::fixedInternalValueFvPatchField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
This boundary condition provides a mechanism to set boundary (cell) values This boundary condition provides a mechanism to set boundary (cell) values

3
src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fixedJumpFvPatchField Foam::fixedJumpFvPatchField
\ingroup grpCoupledBoundaryConditions Group
grpCoupledBoundaryConditions
Description Description
Base class for "jump" of a field<type> Base class for "jump" of a field<type>

3
src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fixedMeanFvPatchField Foam::fixedMeanFvPatchField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
This boundary condition extrapolates field to the patch using the near-cell This boundary condition extrapolates field to the patch using the near-cell

3
src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fixedNormalSlipFvPatchField Foam::fixedNormalSlipFvPatchField
\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions Group
grpGenericBoundaryConditions grpWallBoundaryConditions
Description Description
This boundary condition sets the patch-normal component to a fixed value. This boundary condition sets the patch-normal component to a fixed value.

11
src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
View File

@ -24,22 +24,23 @@ License
Class Class
Foam::fixedPressureCompressibleDensityFvPatchScalarField Foam::fixedPressureCompressibleDensityFvPatchScalarField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition calculates a (liquid) compressible density as a This boundary condition calculates a (liquid) compressible density as a
function of pressure and fluid properties: function of pressure and fluid properties:
\f[ \f[
rho = rho_{l,sat} + psi_l*(p - p_{sat}) \rho = \rho_{l,sat} + \psi_l*(p - p_{sat})
\f] \f]
where where
/vartable /vartable
rho | density [kg/m3] \rho | density [kg/m3]
rho_{l,sat} | saturation liquid density [kg/m3] \rho_{l,sat} | saturation liquid density [kg/m3]
psi_l | liquid compressibility \psi_l | liquid compressibility
p | pressure [Pa] p | pressure [Pa]
p_{sat} | saturation pressure [Pa] p_{sat} | saturation pressure [Pa]
/endvartable /endvartable

3
src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::flowRateInletVelocityFvPatchVectorField Foam::flowRateInletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a velocity boundary condition, derived This boundary condition provides a velocity boundary condition, derived

7
src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::fluxCorrectedVelocityFvPatchVectorField Foam::fluxCorrectedVelocityFvPatchVectorField
\ingroup grpOutletBoundaryConditions Group
grpOutletBoundaryConditions
Description Description
This boundary condition provides a velocity outlet boundary condition for This boundary condition provides a velocity outlet boundary condition for
@ -32,7 +33,7 @@ Description
by "zeroGradient" and then corrected from the flux: by "zeroGradient" and then corrected from the flux:
\f[ \f[
U_p = U_c - n*(n.U_c) + n*phi/mag(Sf) U_p = U_c - n*(n.U_c) + \frac{n*\phi_p}{|Sf|}
\f] \f]
where where
@ -41,7 +42,7 @@ Description
U_p | velocity at the patch [m/s] U_p | velocity at the patch [m/s]
U_c | velocity in cells adjacent to the patch [m/s] U_c | velocity in cells adjacent to the patch [m/s]
n | patch normal vectors n | patch normal vectors
phi | flux at the patch [m3/s or kg/s] \phi_p | flux at the patch [m3/s or kg/s]
Sf | patch face area vectors [m2] Sf | patch face area vectors [m2]
/endvartable /endvartable

3
src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::freestreamFvPatchField Foam::freestreamFvPatchField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a free-stream condition. It is a 'mixed' This boundary condition provides a free-stream condition. It is a 'mixed'

3
src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::freestreamPressureFvPatchScalarField Foam::freestreamPressureFvPatchScalarField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a free-stream condition for pressure. This boundary condition provides a free-stream condition for pressure.

3
src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::inletOutletFvPatchField Foam::inletOutletFvPatchField
\ingroup grpOutletBoundaryConditions Group
grpOutletBoundaryConditions
Description Description
This boundary condition provides a generic outflow condition, with This boundary condition provides a generic outflow condition, with

3
src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::inletOutletTotalTemperatureFvPatchScalarField Foam::inletOutletTotalTemperatureFvPatchScalarField
\ingroup grpOutletBoundaryConditions Group
grpOutletBoundaryConditions
Description Description
This boundary condition provides an outflow condition for total This boundary condition provides an outflow condition for total

3
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::mappedFieldFvPatchField Foam::mappedFieldFvPatchField
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions Group
grpGenericBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary condition provides a self-contained version of the \c mapped This boundary condition provides a self-contained version of the \c mapped

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::mappedFixedInternalValueFvPatchField Foam::mappedFixedInternalValueFvPatchField
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions Group
grpGenericBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary condition maps the boundary and internal values of a This boundary condition maps the boundary and internal values of a

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::mappedFixedPushedInternalValueFvPatchField Foam::mappedFixedPushedInternalValueFvPatchField
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions Group
grpGenericBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary condition maps the boundary values of a neighbour patch This boundary condition maps the boundary values of a neighbour patch

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::mappedFixedValueFvPatchField Foam::mappedFixedValueFvPatchField
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions Group
grpGenericBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary condition maps the value at a set of cells or patch faces This boundary condition maps the value at a set of cells or patch faces

11
src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H
View File

@ -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
@ -24,7 +24,8 @@ License
Class Class
Foam::mappedFlowRateFvPatchVectorField Foam::mappedFlowRateFvPatchVectorField
\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions Group
grpInletBoundaryConditions grpCoupledBoundaryConditions
Description Description
Describes a volumetric/mass flow normal vector boundary condition by its Describes a volumetric/mass flow normal vector boundary condition by its
@ -46,8 +47,8 @@ Description
/endtable /endtable
Example of the boundary condition specification: Example of the boundary condition specification:
/verbatim \verbatim
inlet myPatch
{ {
type mappedFlowRate; type mappedFlowRate;
phi phi; phi phi;
@ -55,7 +56,7 @@ Description
neigPhi phi; neigPhi phi;
value uniform (0 0 0); // placeholder value uniform (0 0 0); // placeholder
} }
/endverbatim \endverbatim
SourceFiles SourceFiles
mappedFlowRateFvPatchVectorField.C mappedFlowRateFvPatchVectorField.C

3
src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::mappedVelocityFluxFixedValueFvPatchField Foam::mappedVelocityFluxFixedValueFvPatchField
\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions Group
grpInletBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary condition maps the velocity and flux from a neighbour patch This boundary condition maps the velocity and flux from a neighbour patch

3
src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::movingWallVelocityFvPatchVectorField Foam::movingWallVelocityFvPatchVectorField
\ingroup grpWallBoundaryConditions Group
grpWallBoundaryConditions
Description Description
This boundary condition provides a velocity condition for cases with This boundary condition provides a velocity condition for cases with

9
src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H
View File

@ -24,23 +24,26 @@ License
Class Class
Foam::multiphaseFixedFluxPressureFvPatchScalarField Foam::multiphaseFixedFluxPressureFvPatchScalarField
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions Group
grpWallBoundaryConditions grpGenericBoundaryConditions
Description Description
This boundary condition adjusts the pressure gradient such that the flux This boundary condition adjusts the pressure gradient such that the flux
on the boundary is that specified by the velocity boundary condition. on the boundary is that specified by the velocity boundary condition.
The predicted flux to be compensated by the pressure gradient is evaluated The predicted flux to be compensated by the pressure gradient is evaluated
as \f$(phi - phiHbyA)\f$, both of which are looked-up from the database, as as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as
is the pressure diffusivity Dp used to calculate the gradient using: is the pressure diffusivity Dp used to calculate the gradient using:
\f[ \f[
grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} \nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| Dp}
\f] \f]
where where
/vartable /vartable
\phi | flux
Dp | pressure diffusivity
Sf | patch face areas [m2] Sf | patch face areas [m2]
/endvartable /endvartable

3
src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::oscillatingFixedValueFvPatchField Foam::oscillatingFixedValueFvPatchField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
This boundary condition provides an oscillating condition in terms of This boundary condition provides an oscillating condition in terms of

3
src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::outletInletFvPatchField Foam::outletInletFvPatchField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a generic inflow condition, with This boundary condition provides a generic inflow condition, with

3
src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::outletMappedUniformInletFvPatchField Foam::outletMappedUniformInletFvPatchField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary conditon averages the field over the "outlet" patch specified This boundary conditon averages the field over the "outlet" patch specified

3
src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::partialSlipFvPatchField Foam::partialSlipFvPatchField
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions Group
grpWallBoundaryConditions grpGenericBoundaryConditions
Description Description
This boundary condition provides a partial slip condition. The amount of This boundary condition provides a partial slip condition. The amount of

5
src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H
View File

@ -24,14 +24,15 @@ License
Class Class
Foam::phaseHydrostaticPressureFvPatchScalarField Foam::phaseHydrostaticPressureFvPatchScalarField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
This boundary condition provides a phase-based hydrostatic pressure This boundary condition provides a phase-based hydrostatic pressure
condition, calculated as: condition, calculated as:
\f[ \f[
p_{hyd} = p_{ref} + \rho*g.(x - x_{ref}) p_{hyd} = p_{ref} + \rho g (x - x_{ref})
\f] \f]
where where

3
src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureDirectedInletOutletVelocityFvPatchVectorField Foam::pressureDirectedInletOutletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This velocity inlet/outlet boundary condition is applied to pressure This velocity inlet/outlet boundary condition is applied to pressure

3
src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureDirectedInletVelocityFvPatchVectorField Foam::pressureDirectedInletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This velocity inlet boundary condition is applied to patches where the This velocity inlet boundary condition is applied to patches where the

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureInletOutletParSlipVelocityFvPatchVectorField Foam::pressureInletOutletParSlipVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This velocity inlet/outlet boundary condition for pressure boundary where This velocity inlet/outlet boundary condition for pressure boundary where

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureInletOutletVelocityFvPatchVectorField Foam::pressureInletOutletVelocityFvPatchVectorField
\ingroup grpInletletBoundaryConditions grpOutletBoundaryConditions Group
grpInletletBoundaryConditions grpOutletBoundaryConditions
Description Description
This velocity inlet/outlet boundary condition is applied to pressure This velocity inlet/outlet boundary condition is applied to pressure

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureInletUniformVelocityFvPatchVectorField Foam::pressureInletUniformVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This velocity inlet boundary condition is applied to patches where the This velocity inlet boundary condition is applied to patches where the

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureInletVelocityFvPatchVectorField Foam::pressureInletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This velocity inlet boundary condition is applied to patches where the This velocity inlet boundary condition is applied to patches where the

3
src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::pressureNormalInletOutletVelocityFvPatchVectorField Foam::pressureNormalInletOutletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This velocity inlet/outlet boundary condition is applied to patches where This velocity inlet/outlet boundary condition is applied to patches where

3
src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::rotatingPressureInletOutletVelocityFvPatchVectorField Foam::rotatingPressureInletOutletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This velocity inlet/outlet boundary condition is applied to patches in a This velocity inlet/outlet boundary condition is applied to patches in a

7
src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::rotatingTotalPressureFvPatchScalarField Foam::rotatingTotalPressureFvPatchScalarField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a total pressure condition for patches This boundary condition provides a total pressure condition for patches
@ -36,8 +37,8 @@ Description
Property | Description | Required | Default value Property | Description | Required | Default value
U | velocity field name | no | U U | velocity field name | no | U
phi | flux field name | no | phi phi | flux field name | no | phi
rho | density field name | no | rho rho | density field name | no | none
psi | compressibility field name | no | psi psi | compressibility field name | no | none
gamma | ratio of specific heats (Cp/Cv) | yes | gamma | ratio of specific heats (Cp/Cv) | yes |
p0 | static pressure reference | yes | p0 | static pressure reference | yes |
omega | angular velocty of the frame [rad/s] | yes | omega | angular velocty of the frame [rad/s] | yes |

3
src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::rotatingWallVelocityFvPatchVectorField Foam::rotatingWallVelocityFvPatchVectorField
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions Group
grpWallBoundaryConditions grpGenericBoundaryConditions
Description Description
This boundary condition provides a rotational velocity condition. This boundary condition provides a rotational velocity condition.

3
src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::slipFvPatchField Foam::slipFvPatchField
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions Group
grpWallBoundaryConditions grpGenericBoundaryConditions
Description Description
This boundary condition provides a slip constraint. This boundary condition provides a slip constraint.

3
src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::supersonicFreestreamFvPatchVectorField Foam::supersonicFreestreamFvPatchVectorField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a supersonic free-stream condition. This boundary condition provides a supersonic free-stream condition.

3
src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::surfaceNormalFixedValueFvPatchVectorField Foam::surfaceNormalFixedValueFvPatchVectorField
\ingroup grpGenericBoundaryConditions grpInletBoundaryConditions Group
grpGenericBoundaryConditions grpInletBoundaryConditions
Description Description
This boundary condition provides a surface-normal vector boundary condition This boundary condition provides a surface-normal vector boundary condition

3
src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::swirlFlowRateInletVelocityFvPatchVectorField Foam::swirlFlowRateInletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a volumetric- OR mass-flow normal vector This boundary condition provides a volumetric- OR mass-flow normal vector

45
src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::syringePressureFvPatchScalarField Foam::syringePressureFvPatchScalarField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a pressure condition, obtained from a This boundary condition provides a pressure condition, obtained from a
@ -40,16 +41,16 @@ Description
/table /table
Property | Description | Required | Default value Property | Description | Required | Default value
Ap | syringe piston area | yes | Ap | syringe piston area [m2] | yes |
Sp | syringe piston speed | yes | Sp | syringe piston speed [m/s] | yes |
VsI | initial syringe volume | yes | VsI | initial syringe volume [m3] | yes |
tas | start of piston acceleration | yes | tas | start of piston acceleration [s] | yes |
tae | end of piston acceleration | yes | tae | end of piston acceleration [s] | yes |
tds | start of piston deceleration | yes | tds | start of piston deceleration [s] | yes |
tde | end of piston deceleration | yes | tde | end of piston deceleration [s] | yes |
psI | initial syringe pressure | yes | psI | initial syringe pressure [Pa] | yes |
psi | gas compressibility | yes | psi | gas compressibility [m2/s2] | yes |
ams | added (or removed) gas mass | yes | ams | added (or removed) gas mass [kg] | yes |
/endtable /endtable
Example of the BC specification: Example of the BC specification:
@ -57,17 +58,17 @@ Description
myPatch myPatch
{ {
type syringePressure; type syringePressure;
Ap 1.388e-6; // syringe piston area Ap 1.388e-6;
Sp 0.01; // syringe piston speed Sp 0.01;
VsI 1.388e-8; // Initial syringe volume VsI 1.388e-8;
tas 0.001; // Start of piston acceleration tas 0.001;
tae 0.002; // End of piston acceleration tae 0.002;
tds 0.005; // Start of piston deceleration tds 0.005;
tde 0.006; // end of piston deceleration tde 0.006;
psI 1e5; // Initial syringe pressure psI 1e5;
psi 1e-5; // Gas compressibility psi 1e-5;
ams 0; // Added (or removed) gas mass ams 0;
value uniform 0 // Initially 0 but used for restarting value uniform 0;
} }
\endverbatim \endverbatim

3
src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::temperatureJumpFvPatchScalarField Foam::temperatureJumpFvPatchScalarField
\ingroup grpCoupledBoundaryConditions Group
grpCoupledBoundaryConditions
Description Description
This boundary condition provides a temperature jump condition across a This boundary condition provides a temperature jump condition across a

5
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
View File

@ -24,12 +24,13 @@ License
Class Class
Foam::timeVaryingMappedFixedValueFvPatchField Foam::timeVaryingMappedFixedValueFvPatchField
\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions Group
grpInletBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary conditions interpolates the values from a set of supplied This boundary conditions interpolates the values from a set of supplied
points in space and time. Supplied data should be specified in points in space and time. Supplied data should be specified in
constant/boundaryData/<patchname> where: constant/boundaryData/\<patchname\> where:
- points : pointField with locations - points : pointField with locations
- ddd : supplied values at time ddd - ddd : supplied values at time ddd
The points should be more or less on a plane since they get triangulated The points should be more or less on a plane since they get triangulated

22
src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H
View File

@ -24,15 +24,16 @@ License
Class Class
Foam::totalPressureFvPatchScalarField Foam::totalPressureFvPatchScalarField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a total pressure condition. Four This boundary condition provides a total pressure condition. Four
variants are possible: variants are possible:
- incompressible subsonic: 1. incompressible subsonic:
\f[ \f[
p_T = p_0 + 0.5*|U|^2 p_T = p_0 + 0.5 |U|^2
\f] \f]
where where
/vartable /vartable
@ -41,9 +42,9 @@ Description
U | velocity U | velocity
/endvartable /endvartable
- compressible subsonic: 2. compressible subsonic:
\f[ \f[
p_T = p_0 + 0.5*\rho*|U|^2 p_T = p_0 + 0.5 \rho |U|^2
\f] \f]
where where
/vartable /vartable
@ -53,26 +54,27 @@ Description
U | velocity U | velocity
/endvartable /endvartable
- compressible supersonic (\gamma > 1): 3. compressible transonic (\gamma <= 1):
\f[ \f[
p_T = \frac{p_0}{(1 + 0.5*\psi*G)^{\frac{1}{G}}} p_T = \frac{p_0}{1 + 0.5 \psi |U|^2}
\f] \f]
where where
/vartable /vartable
p_T | total pressure [Pa] p_T | total pressure [Pa]
p_0 | reference pressure [Pa] p_0 | reference pressure [Pa]
\psi | compressibility [m2/s2]
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
/endvartable /endvartable
- compressible transonic (\gamma <= 1): 4. compressible supersonic (\gamma > 1):
\f[ \f[
p_T = \frac{p_0}{1 + 0.5*\psi*|U|^2} p_T = \frac{p_0}{(1 + 0.5 \psi G)^{\frac{1}{G}}}
\f] \f]
where where
/vartable /vartable
\gamma | ratio of specific heats (Cp/Cv)
p_T | total pressure [Pa] p_T | total pressure [Pa]
p_0 | reference pressure [Pa] p_0 | reference pressure [Pa]
\psi | compressibility [m2/s2]
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
/endvartable /endvartable

3
src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::totalTemperatureFvPatchScalarField Foam::totalTemperatureFvPatchScalarField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a total temperature condition. This boundary condition provides a total temperature condition.

3
src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::translatingWallVelocityFvPatchVectorField Foam::translatingWallVelocityFvPatchVectorField
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions Group
grpWallBoundaryConditions grpGenericBoundaryConditions
Description Description
This boundary condition provides a velocity condition for translational This boundary condition provides a velocity condition for translational

5
src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H
View File

@ -24,14 +24,15 @@ License
Class Class
Foam::turbulentInletFvPatchField Foam::turbulentInletFvPatchField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition generates a fluctuating inlet condition by adding This boundary condition generates a fluctuating inlet condition by adding
a random component to a reference (mean) field. a random component to a reference (mean) field.
\f[ \f[
x_p = (1 - \alpha)*x_p^{n-1} + \alpha*(x_{ref}+C_{RMS}*s*x_{ref}) x_p = (1 - \alpha) x_p^{n-1} + \alpha (x_{ref} + s C_{RMS} x_{ref})
\f] \f]
where where

5
src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a turbulent kinetic energy condition, This boundary condition provides a turbulent kinetic energy condition,
@ -32,7 +33,7 @@ Description
mean velocity: mean velocity:
\f[ \f[
k_p = 1.5*(I)*|U|^2 k_p = 1.5 I |U|^2
\f] \f]
where where

5
src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H
View File

@ -24,14 +24,15 @@ License
Class Class
Foam::uniformDensityHydrostaticPressureFvPatchScalarField Foam::uniformDensityHydrostaticPressureFvPatchScalarField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
This boundary condition provides a hydrostatic pressure condition, This boundary condition provides a hydrostatic pressure condition,
calculated as: calculated as:
\f[ \f[
p_{hyd} = p_{ref} + \rho*g.(x - x_{ref}) p_{hyd} = p_{ref} + \rho g (x - x_{ref})
\f] \f]
where where

3
src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::uniformFixedValueFvPatchField Foam::uniformFixedValueFvPatchField
\ingroup grpGenericBoundaryConditions Group
grpGenericBoundaryConditions
Description Description
This boundary condition provides a uniform fixed value condition. This boundary condition provides a uniform fixed value condition.

3
src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::uniformTotalPressureFvPatchScalarField Foam::uniformTotalPressureFvPatchScalarField
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions Group
grpInletBoundaryConditions grpOutletBoundaryConditions
Description Description
This boundary condition provides a time-varying form of the uniform total This boundary condition provides a time-varying form of the uniform total

5
src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::variableHeightFlowRateFvPatchScalarField Foam::variableHeightFlowRateFvPatchScalarField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a phase fraction condition based on the This boundary condition provides a phase fraction condition based on the
@ -58,7 +59,7 @@ Description
upperBound 0.9; upperBound 0.9;
value uniform 0; value uniform 0;
} }
\verbatim \endverbatim
SourceFiles SourceFiles
variableHeightFlowRateFvPatchScalarField.C variableHeightFlowRateFvPatchScalarField.C

3
src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::variableHeightFlowRateInletVelocityFvPatchVectorField Foam::variableHeightFlowRateInletVelocityFvPatchVectorField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This boundary condition provides a velocity boundary condition for This boundary condition provides a velocity boundary condition for

3
src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::waveSurfacePressureFvPatchScalarField Foam::waveSurfacePressureFvPatchScalarField
\ingroup grpInletBoundaryConditions Group
grpInletBoundaryConditions
Description Description
This is a pressure boundary condition, whose value is calculated as This is a pressure boundary condition, whose value is calculated as

3
src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::waveTransmissiveFvPatchField Foam::waveTransmissiveFvPatchField
\ingroup grpOutletBoundaryConditions Group
grpOutletBoundaryConditions
Description Description
This boundary condition provides a wave transmissive outflow condition, This boundary condition provides a wave transmissive outflow condition,

39
src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox Normal file
View File

@ -0,0 +1,39 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\/ 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/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\page pageBoundaryConditions Boundary Conditions
\ref grpBoundaryConditions
\section secBoundaryConditionsOverview Overview
- \ref grpConstraintBoundaryConditions
- \ref grpInletBoundaryConditions
- \ref grpOutletBoundaryConditions
- \ref grpGenericBoundaryConditions
- \ref grpCoupledBoundaryConditions
- \ref grpWallBoundaryConditions
\*---------------------------------------------------------------------------*/

4
src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H → src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
View File

@ -52,7 +52,7 @@ License
This group contains generic boundary condition types This group contains generic boundary condition types
@} @}
\defgroup grpGenericBoundaryConditions Coupled boundary Conditions \defgroup grpCoupledBoundaryConditions Coupled boundary Conditions
@{ @{
\ingroup grpBoundaryConditions \ingroup grpBoundaryConditions
This group contains coupled boundary condition types This group contains coupled boundary condition types
@ -64,4 +64,4 @@ License
This group contains wall boundary condition types This group contains wall boundary condition types
@} @}
// ************************************************************************* // \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpIOFunctionObjects
@{
Class Class
Foam::partialWrite Foam::partialWrite
\ingroup grpIOFunctionObjects
Description Description
Allows some fields/registered objects to be written more often than others. Allows some fields/registered objects to be written more often than others.
@ -36,7 +35,6 @@ Description
SourceFiles SourceFiles
partialWrite.C partialWrite.C
IOpartialWrite.H IOpartialWrite.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H
View File

@ -21,19 +21,17 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpIOFunctionObjects
@{
Class Class
Foam::removeRegisteredObject Foam::removeRegisteredObject
\ingroup grpIOFunctionObjects
Description Description
Removes registered IO objects if present in the database Removes registered IO objects if present in the database
SourceFiles SourceFiles
removeRegisteredObject.C removeRegisteredObject.C
IOremoveRegisteredObject.H IOremoveRegisteredObject.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H
View File

@ -21,19 +21,17 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpIOFunctionObjects
@{
Class Class
Foam::writeRegisteredObject Foam::writeRegisteredObject
\ingroup grpIOFunctionObjects
Description Description
Takes over the writing of registered IO objects Takes over the writing of registered IO objects
SourceFiles SourceFiles
writeRegisteredObject.C writeRegisteredObject.C
IOwriteRegisteredObject.H IOwriteRegisteredObject.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpCloudFunctionObjects
@{
Class Class
Foam::cloudInfo Foam::cloudInfo
\ingroup grpCloudFunctionObjects
Description Description
This function object outputs lagrangian cloud information to a file. The This function object outputs lagrangian cloud information to a file. The
current outputs include: current outputs include:
@ -36,7 +35,6 @@ Description
SourceFiles SourceFiles
cloudInfo.C cloudInfo.C
IOcloudInfo.H IOcloudInfo.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::fieldAverage Foam::fieldAverage
\ingroup grpFieldFunctionObjects
Description Description
Calculates the field averages given list of fieldAverageItems, e.g. Calculates the field averages given list of fieldAverageItems, e.g.
@ -83,7 +82,6 @@ Description
SourceFiles SourceFiles
fieldAverage.C fieldAverage.C
fieldAverageTemplates.C fieldAverageTemplates.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
class class
Foam::fieldCoordinateSystemTransform Foam::fieldCoordinateSystemTransform
\ingroup grpFieldFunctionObjects
Description Description
Transforms fields from global cartesian co-ordinates to local co-ordinate Transforms fields from global cartesian co-ordinates to local co-ordinate
system system
@ -35,7 +34,6 @@ SourceFiles
fieldCoordinateSystemTransform.C fieldCoordinateSystemTransform.C
fieldCoordinateSystemTransformTemplates.C fieldCoordinateSystemTransformTemplates.C
IOfieldCoordinateSystemTransform.H IOfieldCoordinateSystemTransform.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::fieldMinMax Foam::fieldMinMax
\ingroup grpFieldFunctionObjects
Description Description
Calculates scalar minimim and maximum field values. Calculates scalar minimim and maximum field values.
@ -39,7 +38,6 @@ Description
SourceFiles SourceFiles
fieldMinMax.C fieldMinMax.C
IOfieldMinMax.H IOfieldMinMax.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H
View File

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::fieldValue Foam::fieldValue
\ingroup grpFieldFunctionObjects
Description Description
Base class for field value -based function objects. Base class for field value -based function objects.
SourceFiles SourceFiles
fieldValue.C fieldValue.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::nearWallFields Foam::nearWallFields
\ingroup grpFieldFunctionObjects
Description Description
Samples near-patch volFields Samples near-patch volFields
@ -56,7 +55,6 @@ Description
SourceFiles SourceFiles
nearWallFields.C nearWallFields.C
IOnearWallFields.H IOnearWallFields.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/processorField/processorField.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::processorField Foam::processorField
\ingroup grpFieldFunctionObjects
Description Description
Writes a scalar field whose value is the local processor ID. Output Writes a scalar field whose value is the local processor ID. Output
field name is processorID. field name is processorID.
@ -34,7 +33,6 @@ Description
SourceFiles SourceFiles
processorField.C processorField.C
IOprocessorField.H IOprocessorField.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/readFields/readFields.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::readFields Foam::readFields
\ingroup grpFieldFunctionObjects
Description Description
Reads fields from the time folders and adds them to the mesh database Reads fields from the time folders and adds them to the mesh database
for further post-processing. for further post-processing.
@ -34,7 +33,6 @@ Description
SourceFiles SourceFiles
readFields.C readFields.C
IOreadFields.H IOreadFields.H
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::regionSizeDistribution Foam::regionSizeDistribution
\ingroup grpFieldFunctionObjects
Description Description
Looks up a field, interpolates it to the faces and determines a connected Looks up a field, interpolates it to the faces and determines a connected
region from a patch where the field is above a certain value. region from a patch where the field is above a certain value.
@ -36,7 +35,6 @@ Description
SourceFiles SourceFiles
regionSizeDistribution.C regionSizeDistribution.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/streamLine/streamLine.H
View File

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class Class
Foam::streamLine Foam::streamLine
\ingroup grpFieldFunctionObjects
Description Description
Generation of streamlines. Samples along track of passive particle. Generation of streamlines. Samples along track of passive particle.
SourceFiles SourceFiles
streamLine.C streamLine.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

Some files were not shown because too many files have changed in this diff Show More