mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: doxygen documentation updates
This commit is contained in:
andy
@ -21,6 +21,8 @@ License
|
||||
You should have received a copy of the GNU General Public License along with
|
||||
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpFunctionObjects Function objects
|
||||
@{
|
||||
This group contains function objects
|
||||
|
||||
@ -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,8 @@ License
|
||||
You should have received a copy of the GNU General Public License along with
|
||||
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\mainpage OpenFOAM®: open source CFD
|
||||
|
||||
\section about About OpenFOAM
|
||||
@ -34,4 +36,28 @@ License
|
||||
turbulence and heat transfer, to solid dynamics and electromagnetics.
|
||||
<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
|
||||
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -21,20 +21,18 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::basicSymmetryFvPatchField
|
||||
|
||||
Group
|
||||
grpConstraintBoundaryConditions
|
||||
|
||||
Description
|
||||
A symmetry patch
|
||||
|
||||
SourceFiles
|
||||
basicSymmetryFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef basicSymmetryFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::calculatedFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
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
|
||||
@ -46,8 +46,6 @@ Description
|
||||
SourceFiles
|
||||
calculatedFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef calculatedFvPatchField_H
|
||||
|
||||
@ -21,20 +21,18 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::coupledFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
Abstract base class for coupled patches.
|
||||
|
||||
SourceFiles
|
||||
coupledFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef coupledFvPatchField_H
|
||||
|
||||
@ -21,20 +21,18 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::directionMixedFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
Base class for direction-mixed boundary conditions.
|
||||
|
||||
SourceFiles
|
||||
directionMixedFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef directionMixedFvPatchField_H
|
||||
|
||||
@ -21,26 +21,26 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::fixedGradientFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition supplies a fixed gradient condition, such that
|
||||
the patch values are calculated using:
|
||||
|
||||
\f[
|
||||
values = int + gradient/delta
|
||||
x_p = x_c + \frac{\nabla(x)}{\Delta}
|
||||
\f]
|
||||
|
||||
where
|
||||
/vartable
|
||||
values | patch values
|
||||
int | internal field values
|
||||
gradient | gradient (user-specified)
|
||||
delta | inverse distance from patch face centre to cell centre
|
||||
x_p | patch values
|
||||
x_c | internal field values
|
||||
\nabla(x)| gradient (user-specified)
|
||||
\Delta | inverse distance from patch face centre to cell centre
|
||||
/endvartable
|
||||
|
||||
/heading Patch usage
|
||||
@ -62,8 +62,6 @@ Description
|
||||
SourceFiles
|
||||
fixedGradientFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef fixedGradientFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::fixedValueFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition supplies a fixed value constraint, and is the base
|
||||
class for a number of other boundary conditions.
|
||||
@ -50,8 +50,6 @@ Description
|
||||
SourceFiles
|
||||
fixedValueFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef fixedValueFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::mixedFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a base class for 'mixed' type boundary
|
||||
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:
|
||||
|
||||
\f[
|
||||
x_p = w*A + (1-w)*(x_c + B/delta)
|
||||
x_p = w*A + (1-w)*(x_c + B/\Delta)
|
||||
\f]
|
||||
|
||||
where
|
||||
@ -45,7 +45,7 @@ Description
|
||||
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
|
||||
\Delta| inverse distance from face centre to internal cell centre
|
||||
/endvartable
|
||||
|
||||
\note
|
||||
@ -58,8 +58,6 @@ SeeAlso
|
||||
SourceFiles
|
||||
mixedFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef mixedFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::slicedFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
Specialization of fvPatchField which creates the underlying
|
||||
fvPatchField as a slice of the given complete field.
|
||||
@ -42,8 +42,6 @@ SeeAlso
|
||||
SourceFiles
|
||||
slicedFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef slicedFvPatchField_H
|
||||
|
||||
@ -21,20 +21,18 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::transformFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
Foam::transformFvPatchField
|
||||
|
||||
SourceFiles
|
||||
transformFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef transformFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::zeroGradientFvPatchField
|
||||
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition appies a zero-gradient condition from the patch
|
||||
internal field onto the patch faces.
|
||||
@ -43,7 +43,6 @@ Description
|
||||
|
||||
SourceFiles
|
||||
zeroGradientFvPatchField.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::cyclicFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition enforces a cyclic condition between a pair of
|
||||
boundaries.
|
||||
@ -49,8 +49,6 @@ Description
|
||||
SourceFiles
|
||||
cyclicFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef cyclicFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::cyclicAMIFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition enforces a cyclic condition between a pair of
|
||||
boundaries, whereby communication between the patches is performed using
|
||||
@ -53,8 +53,6 @@ SeeAlso
|
||||
SourceFiles
|
||||
cyclicAMIFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef cyclicAMIFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::cyclicSlipFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition is a light wrapper around the cyclicFvPatchField
|
||||
condition, providing no new functionality.
|
||||
@ -47,8 +47,6 @@ SeeAlso
|
||||
SourceFiles
|
||||
cyclicSlipFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef cyclicSlipFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::emptyFvPatchField
|
||||
|
||||
Group
|
||||
grpConstraintBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides an 'empty' condition for reduced
|
||||
dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to
|
||||
@ -46,8 +46,6 @@ Description
|
||||
SourceFiles
|
||||
emptyFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef emptyFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::jumpCyclicFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a base class for coupled-cyclic
|
||||
conditions with a specified 'jump' (or offset) between the values
|
||||
@ -37,8 +37,6 @@ SeeAlso
|
||||
SourceFiles
|
||||
jumpCyclicFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef jumpCyclicFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::nonuniformTransformCyclicFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition enforces a cyclic condition between a pair of
|
||||
boundaries, incorporating a non-uniform transformation.
|
||||
@ -37,8 +37,6 @@ SourceFiles
|
||||
nonuniformTransformCyclicFvPatchFields.C
|
||||
nonuniformTransformCyclicFvPatchFieldsFwd.H
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef nonuniformTransformCyclicFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::processorFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition enables processor communication across patches.
|
||||
|
||||
@ -43,8 +43,6 @@ Description
|
||||
SourceFiles
|
||||
processorFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef processorFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::processorCyclicFvPatchField
|
||||
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition enables processor communication across cyclic
|
||||
patches.
|
||||
@ -50,8 +50,6 @@ SourceFiles
|
||||
processorCyclicFvPatchFields.C
|
||||
processorCyclicFvPatchFieldsFwd.H
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef processorCyclicFvPatchField_H
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::symmetryFvPatchField
|
||||
|
||||
Group
|
||||
grpConstraintBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition enforces a symmetry constraint
|
||||
|
||||
@ -45,7 +45,6 @@ SourceFiles
|
||||
symmetryFvPatchFields.C
|
||||
symmetryFvPatchFields.H
|
||||
symmetryFvPatchFieldsFwd.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,12 @@ 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 grpBoundaryConditions
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::wedgeFvPatchField
|
||||
|
||||
Group
|
||||
grpConstraintBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition is similar to the cyclic condition, except that
|
||||
it is applied to 2-D geometries.
|
||||
@ -47,8 +47,6 @@ SeeAlso
|
||||
SourceFiles
|
||||
wedgeFvPatchField.C
|
||||
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef wedgeFvPatchField_H
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::activeBaffleVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity boundary condition simulates the opening of a baffle due
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::activePressureForceBaffleVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition is applied to the flow velocity, to simulate the
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::advectiveFvPatchField
|
||||
|
||||
\ingroup grpOutletBoundaryConditions
|
||||
Group
|
||||
grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides an advective outflow condition, based on
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::buoyantPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpWallBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition sets the pressure gradient appropriately for
|
||||
@ -34,31 +35,30 @@ Description
|
||||
- \c pd
|
||||
- \c p_rgh
|
||||
- \c ph_rgh
|
||||
we assume that the pressure variable is \f$p - rho*g.h\f$ and the gradient
|
||||
set using:
|
||||
we assume that the pressure variable is \f$p - \rho(g \cdot h)\f$ and the
|
||||
gradient set using:
|
||||
\f[
|
||||
grad(pressure) = -snGrad(rho)*(g.h)
|
||||
\nabla(p) = -\nabla_\perp(\rho)(g \cdot h)
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
/vartable
|
||||
snGrad | surface-normal gradient operator
|
||||
rho | density [kg/m3]
|
||||
\rho | density [kg/m3]
|
||||
g | acceleration due to gravity [m/s2]
|
||||
h | patch face centres [m]
|
||||
/endtable
|
||||
/endvartable
|
||||
|
||||
Otherwise we assume that it is the static pressure, and the gradient
|
||||
calculated using:
|
||||
\f[
|
||||
grad(pressure) = rho*(g.n)
|
||||
\nabla(p) = \rho(g \cdot n)
|
||||
\f]
|
||||
|
||||
where
|
||||
/vartable
|
||||
n | patch face normal vectors
|
||||
/endtable
|
||||
/endvartable
|
||||
|
||||
/heading Patch usage
|
||||
|
||||
@ -94,7 +94,7 @@ namespace Foam
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class buoyantPressureFvPatch Declaration
|
||||
Class buoyantPressureFvPatchScalarField Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
class buoyantPressureFvPatchScalarField
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::codedFixedValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
Constructs on-the-fly a new boundary condition (derived from
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::codedMixedFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
Constructs on-the-fly a new boundary condition (derived from
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::cylindricalInletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition describes an inlet vector boundary condition in
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fanFvPatchField
|
||||
|
||||
\ingroup grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition supplies a jump condition, using the \c cyclic
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fanPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition can be applied to assign either a pressure inlet
|
||||
@ -97,8 +98,10 @@ public:
|
||||
ffdOut
|
||||
};
|
||||
|
||||
//- Fan flow directions names
|
||||
static const NamedEnum<fanFlowDirection, 2> fanFlowDirectionNames_;
|
||||
|
||||
|
||||
private:
|
||||
|
||||
// Private data
|
||||
|
||||
@ -24,23 +24,26 @@ License
|
||||
Class
|
||||
Foam::fixedFluxPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpBoundaryConditions
|
||||
Group
|
||||
grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition adjusts the pressure gradient such that the flux
|
||||
on the boundary is that specified by the velocity boundary condition.
|
||||
|
||||
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
|
||||
is the pressure diffusivity \c Dp used to calculate the gradient using:
|
||||
as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as
|
||||
is the pressure diffusivity used to calculate the gradient using:
|
||||
|
||||
\f[
|
||||
grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp}
|
||||
\nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| D_p}
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
/vartable
|
||||
phi | flux
|
||||
D_p | pressure diffusivity
|
||||
Sf | patch face areas [m2]
|
||||
/endvartable
|
||||
|
||||
@ -58,7 +61,7 @@ Description
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type externalWallHeatFluxTemperature;
|
||||
type fixedFluxPressure;
|
||||
phiHbyA phiHbyA;
|
||||
phi phi;
|
||||
rho rho;
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fixedInternalValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a mechanism to set boundary (cell) values
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fixedJumpFvPatchField
|
||||
|
||||
\ingroup grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
Base class for "jump" of a field<type>
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fixedMeanFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition extrapolates field to the patch using the near-cell
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fixedNormalSlipFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpWallBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition sets the patch-normal component to a fixed value.
|
||||
|
||||
@ -24,22 +24,23 @@ License
|
||||
Class
|
||||
Foam::fixedPressureCompressibleDensityFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition calculates a (liquid) compressible density as a
|
||||
function of pressure and fluid properties:
|
||||
|
||||
\f[
|
||||
rho = rho_{l,sat} + psi_l*(p - p_{sat})
|
||||
\rho = \rho_{l,sat} + \psi_l*(p - p_{sat})
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
/vartable
|
||||
rho | density [kg/m3]
|
||||
rho_{l,sat} | saturation liquid density [kg/m3]
|
||||
psi_l | liquid compressibility
|
||||
\rho | density [kg/m3]
|
||||
\rho_{l,sat} | saturation liquid density [kg/m3]
|
||||
\psi_l | liquid compressibility
|
||||
p | pressure [Pa]
|
||||
p_{sat} | saturation pressure [Pa]
|
||||
/endvartable
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::flowRateInletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a velocity boundary condition, derived
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fluxCorrectedVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpOutletBoundaryConditions
|
||||
Group
|
||||
grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a velocity outlet boundary condition for
|
||||
@ -32,7 +33,7 @@ Description
|
||||
by "zeroGradient" and then corrected from the flux:
|
||||
|
||||
\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]
|
||||
|
||||
where
|
||||
@ -41,7 +42,7 @@ Description
|
||||
U_p | velocity at the patch [m/s]
|
||||
U_c | velocity in cells adjacent to the patch [m/s]
|
||||
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]
|
||||
/endvartable
|
||||
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::freestreamFvPatchField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a free-stream condition. It is a 'mixed'
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::freestreamPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a free-stream condition for pressure.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::inletOutletFvPatchField
|
||||
|
||||
\ingroup grpOutletBoundaryConditions
|
||||
Group
|
||||
grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a generic outflow condition, with
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::inletOutletTotalTemperatureFvPatchScalarField
|
||||
|
||||
\ingroup grpOutletBoundaryConditions
|
||||
Group
|
||||
grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides an outflow condition for total
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::mappedFieldFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a self-contained version of the \c mapped
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::mappedFixedInternalValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition maps the boundary and internal values of a
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::mappedFixedPushedInternalValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition maps the boundary values of a neighbour patch
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::mappedFixedValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition maps the value at a set of cells or patch faces
|
||||
|
||||
@ -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
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::mappedFlowRateFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
Describes a volumetric/mass flow normal vector boundary condition by its
|
||||
@ -46,8 +47,8 @@ Description
|
||||
/endtable
|
||||
|
||||
Example of the boundary condition specification:
|
||||
/verbatim
|
||||
inlet
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type mappedFlowRate;
|
||||
phi phi;
|
||||
@ -55,7 +56,7 @@ Description
|
||||
neigPhi phi;
|
||||
value uniform (0 0 0); // placeholder
|
||||
}
|
||||
/endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
mappedFlowRateFvPatchVectorField.C
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::mappedVelocityFluxFixedValueFvPatchField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition maps the velocity and flux from a neighbour patch
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::movingWallVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpWallBoundaryConditions
|
||||
Group
|
||||
grpWallBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a velocity condition for cases with
|
||||
|
||||
@ -24,23 +24,26 @@ License
|
||||
Class
|
||||
Foam::multiphaseFixedFluxPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
Group
|
||||
grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition adjusts the pressure gradient such that the flux
|
||||
on the boundary is that specified by the velocity boundary condition.
|
||||
|
||||
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:
|
||||
|
||||
\f[
|
||||
grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp}
|
||||
\nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| Dp}
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
/vartable
|
||||
\phi | flux
|
||||
Dp | pressure diffusivity
|
||||
Sf | patch face areas [m2]
|
||||
/endvartable
|
||||
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::oscillatingFixedValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides an oscillating condition in terms of
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::outletInletFvPatchField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a generic inflow condition, with
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::outletMappedUniformInletFvPatchField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary conditon averages the field over the "outlet" patch specified
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::partialSlipFvPatchField
|
||||
|
||||
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
Group
|
||||
grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a partial slip condition. The amount of
|
||||
|
||||
@ -24,14 +24,15 @@ License
|
||||
Class
|
||||
Foam::phaseHydrostaticPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a phase-based hydrostatic pressure
|
||||
condition, calculated as:
|
||||
|
||||
\f[
|
||||
p_{hyd} = p_{ref} + \rho*g.(x - x_{ref})
|
||||
p_{hyd} = p_{ref} + \rho g (x - x_{ref})
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureDirectedInletOutletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet/outlet boundary condition is applied to pressure
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureDirectedInletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet boundary condition is applied to patches where the
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureInletOutletParSlipVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet/outlet boundary condition for pressure boundary where
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureInletOutletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet/outlet boundary condition is applied to pressure
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureInletUniformVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet boundary condition is applied to patches where the
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureInletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet boundary condition is applied to patches where the
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::pressureNormalInletOutletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet/outlet boundary condition is applied to patches where
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::rotatingPressureInletOutletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This velocity inlet/outlet boundary condition is applied to patches in a
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::rotatingTotalPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a total pressure condition for patches
|
||||
@ -36,8 +37,8 @@ Description
|
||||
Property | Description | Required | Default value
|
||||
U | velocity field name | no | U
|
||||
phi | flux field name | no | phi
|
||||
rho | density field name | no | rho
|
||||
psi | compressibility field name | no | psi
|
||||
rho | density field name | no | none
|
||||
psi | compressibility field name | no | none
|
||||
gamma | ratio of specific heats (Cp/Cv) | yes |
|
||||
p0 | static pressure reference | yes |
|
||||
omega | angular velocty of the frame [rad/s] | yes |
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::rotatingWallVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
Group
|
||||
grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a rotational velocity condition.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::slipFvPatchField
|
||||
|
||||
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
Group
|
||||
grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a slip constraint.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::supersonicFreestreamFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a supersonic free-stream condition.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::surfaceNormalFixedValueFvPatchVectorField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions grpInletBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a surface-normal vector boundary condition
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::swirlFlowRateInletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a volumetric- OR mass-flow normal vector
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::syringePressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a pressure condition, obtained from a
|
||||
@ -40,16 +41,16 @@ Description
|
||||
|
||||
/table
|
||||
Property | Description | Required | Default value
|
||||
Ap | syringe piston area | yes |
|
||||
Sp | syringe piston speed | yes |
|
||||
VsI | initial syringe volume | yes |
|
||||
tas | start of piston acceleration | yes |
|
||||
tae | end of piston acceleration | yes |
|
||||
tds | start of piston deceleration | yes |
|
||||
tde | end of piston deceleration | yes |
|
||||
psI | initial syringe pressure | yes |
|
||||
psi | gas compressibility | yes |
|
||||
ams | added (or removed) gas mass | yes |
|
||||
Ap | syringe piston area [m2] | yes |
|
||||
Sp | syringe piston speed [m/s] | yes |
|
||||
VsI | initial syringe volume [m3] | yes |
|
||||
tas | start of piston acceleration [s] | yes |
|
||||
tae | end of piston acceleration [s] | yes |
|
||||
tds | start of piston deceleration [s] | yes |
|
||||
tde | end of piston deceleration [s] | yes |
|
||||
psI | initial syringe pressure [Pa] | yes |
|
||||
psi | gas compressibility [m2/s2] | yes |
|
||||
ams | added (or removed) gas mass [kg] | yes |
|
||||
/endtable
|
||||
|
||||
Example of the BC specification:
|
||||
@ -57,17 +58,17 @@ Description
|
||||
myPatch
|
||||
{
|
||||
type syringePressure;
|
||||
Ap 1.388e-6; // syringe piston area
|
||||
Sp 0.01; // syringe piston speed
|
||||
VsI 1.388e-8; // Initial syringe volume
|
||||
tas 0.001; // Start of piston acceleration
|
||||
tae 0.002; // End of piston acceleration
|
||||
tds 0.005; // Start of piston deceleration
|
||||
tde 0.006; // end of piston deceleration
|
||||
psI 1e5; // Initial syringe pressure
|
||||
psi 1e-5; // Gas compressibility
|
||||
ams 0; // Added (or removed) gas mass
|
||||
value uniform 0 // Initially 0 but used for restarting
|
||||
Ap 1.388e-6;
|
||||
Sp 0.01;
|
||||
VsI 1.388e-8;
|
||||
tas 0.001;
|
||||
tae 0.002;
|
||||
tds 0.005;
|
||||
tde 0.006;
|
||||
psI 1e5;
|
||||
psi 1e-5;
|
||||
ams 0;
|
||||
value uniform 0;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::temperatureJumpFvPatchScalarField
|
||||
|
||||
\ingroup grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a temperature jump condition across a
|
||||
|
||||
@ -24,12 +24,13 @@ License
|
||||
Class
|
||||
Foam::timeVaryingMappedFixedValueFvPatchField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpCoupledBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary conditions interpolates the values from a set of supplied
|
||||
points in space and time. Supplied data should be specified in
|
||||
constant/boundaryData/<patchname> where:
|
||||
constant/boundaryData/\<patchname\> where:
|
||||
- points : pointField with locations
|
||||
- ddd : supplied values at time ddd
|
||||
The points should be more or less on a plane since they get triangulated
|
||||
|
||||
@ -24,15 +24,16 @@ License
|
||||
Class
|
||||
Foam::totalPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a total pressure condition. Four
|
||||
variants are possible:
|
||||
|
||||
- incompressible subsonic:
|
||||
1. incompressible subsonic:
|
||||
\f[
|
||||
p_T = p_0 + 0.5*|U|^2
|
||||
p_T = p_0 + 0.5 |U|^2
|
||||
\f]
|
||||
where
|
||||
/vartable
|
||||
@ -41,9 +42,9 @@ Description
|
||||
U | velocity
|
||||
/endvartable
|
||||
|
||||
- compressible subsonic:
|
||||
2. compressible subsonic:
|
||||
\f[
|
||||
p_T = p_0 + 0.5*\rho*|U|^2
|
||||
p_T = p_0 + 0.5 \rho |U|^2
|
||||
\f]
|
||||
where
|
||||
/vartable
|
||||
@ -53,26 +54,27 @@ Description
|
||||
U | velocity
|
||||
/endvartable
|
||||
|
||||
- compressible supersonic (\gamma > 1):
|
||||
3. compressible transonic (\gamma <= 1):
|
||||
\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]
|
||||
where
|
||||
/vartable
|
||||
p_T | total pressure [Pa]
|
||||
p_0 | reference pressure [Pa]
|
||||
\psi | compressibility [m2/s2]
|
||||
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
|
||||
/endvartable
|
||||
|
||||
- compressible transonic (\gamma <= 1):
|
||||
4. compressible supersonic (\gamma > 1):
|
||||
\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]
|
||||
where
|
||||
/vartable
|
||||
\gamma | ratio of specific heats (Cp/Cv)
|
||||
p_T | total pressure [Pa]
|
||||
p_0 | reference pressure [Pa]
|
||||
\psi | compressibility [m2/s2]
|
||||
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
|
||||
/endvartable
|
||||
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::totalTemperatureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a total temperature condition.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::translatingWallVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
Group
|
||||
grpWallBoundaryConditions grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a velocity condition for translational
|
||||
|
||||
@ -24,14 +24,15 @@ License
|
||||
Class
|
||||
Foam::turbulentInletFvPatchField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition generates a fluctuating inlet condition by adding
|
||||
a random component to a reference (mean) field.
|
||||
|
||||
\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]
|
||||
|
||||
where
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a turbulent kinetic energy condition,
|
||||
@ -32,7 +33,7 @@ Description
|
||||
mean velocity:
|
||||
|
||||
\f[
|
||||
k_p = 1.5*(I)*|U|^2
|
||||
k_p = 1.5 I |U|^2
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
@ -24,14 +24,15 @@ License
|
||||
Class
|
||||
Foam::uniformDensityHydrostaticPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a hydrostatic pressure condition,
|
||||
calculated as:
|
||||
|
||||
\f[
|
||||
p_{hyd} = p_{ref} + \rho*g.(x - x_{ref})
|
||||
p_{hyd} = p_{ref} + \rho g (x - x_{ref})
|
||||
\f]
|
||||
|
||||
where
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::uniformFixedValueFvPatchField
|
||||
|
||||
\ingroup grpGenericBoundaryConditions
|
||||
Group
|
||||
grpGenericBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a uniform fixed value condition.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::uniformTotalPressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a time-varying form of the uniform total
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::variableHeightFlowRateFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a phase fraction condition based on the
|
||||
@ -58,7 +59,7 @@ Description
|
||||
upperBound 0.9;
|
||||
value uniform 0;
|
||||
}
|
||||
\verbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
variableHeightFlowRateFvPatchScalarField.C
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::variableHeightFlowRateInletVelocityFvPatchVectorField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a velocity boundary condition for
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::waveSurfacePressureFvPatchScalarField
|
||||
|
||||
\ingroup grpInletBoundaryConditions
|
||||
Group
|
||||
grpInletBoundaryConditions
|
||||
|
||||
Description
|
||||
This is a pressure boundary condition, whose value is calculated as
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::waveTransmissiveFvPatchField
|
||||
|
||||
\ingroup grpOutletBoundaryConditions
|
||||
Group
|
||||
grpOutletBoundaryConditions
|
||||
|
||||
Description
|
||||
This boundary condition provides a wave transmissive outflow condition,
|
||||
|
||||
@ -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
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -52,7 +52,7 @@ License
|
||||
This group contains generic boundary condition types
|
||||
@}
|
||||
|
||||
\defgroup grpGenericBoundaryConditions Coupled boundary Conditions
|
||||
\defgroup grpCoupledBoundaryConditions Coupled boundary Conditions
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains coupled boundary condition types
|
||||
@ -64,4 +64,4 @@ License
|
||||
This group contains wall boundary condition types
|
||||
@}
|
||||
|
||||
// ************************************************************************* //
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -21,12 +21,11 @@ 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 grpIOFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::partialWrite
|
||||
|
||||
\ingroup grpIOFunctionObjects
|
||||
|
||||
Description
|
||||
Allows some fields/registered objects to be written more often than others.
|
||||
|
||||
@ -36,7 +35,6 @@ Description
|
||||
SourceFiles
|
||||
partialWrite.C
|
||||
IOpartialWrite.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,19 +21,17 @@ 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 grpIOFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::removeRegisteredObject
|
||||
|
||||
\ingroup grpIOFunctionObjects
|
||||
|
||||
Description
|
||||
Removes registered IO objects if present in the database
|
||||
|
||||
SourceFiles
|
||||
removeRegisteredObject.C
|
||||
IOremoveRegisteredObject.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,19 +21,17 @@ 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 grpIOFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::writeRegisteredObject
|
||||
|
||||
\ingroup grpIOFunctionObjects
|
||||
|
||||
Description
|
||||
Takes over the writing of registered IO objects
|
||||
|
||||
SourceFiles
|
||||
writeRegisteredObject.C
|
||||
IOwriteRegisteredObject.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpCloudFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::cloudInfo
|
||||
|
||||
\ingroup grpCloudFunctionObjects
|
||||
|
||||
Description
|
||||
This function object outputs lagrangian cloud information to a file. The
|
||||
current outputs include:
|
||||
@ -36,7 +35,6 @@ Description
|
||||
SourceFiles
|
||||
cloudInfo.C
|
||||
IOcloudInfo.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::fieldAverage
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates the field averages given list of fieldAverageItems, e.g.
|
||||
|
||||
@ -83,7 +82,6 @@ Description
|
||||
SourceFiles
|
||||
fieldAverage.C
|
||||
fieldAverageTemplates.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
class
|
||||
Foam::fieldCoordinateSystemTransform
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Transforms fields from global cartesian co-ordinates to local co-ordinate
|
||||
system
|
||||
@ -35,7 +34,6 @@ SourceFiles
|
||||
fieldCoordinateSystemTransform.C
|
||||
fieldCoordinateSystemTransformTemplates.C
|
||||
IOfieldCoordinateSystemTransform.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::fieldMinMax
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates scalar minimim and maximum field values.
|
||||
|
||||
@ -39,7 +38,6 @@ Description
|
||||
SourceFiles
|
||||
fieldMinMax.C
|
||||
IOfieldMinMax.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,18 +21,16 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::fieldValue
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Base class for field value -based function objects.
|
||||
|
||||
SourceFiles
|
||||
fieldValue.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::nearWallFields
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Samples near-patch volFields
|
||||
|
||||
@ -56,7 +55,6 @@ Description
|
||||
SourceFiles
|
||||
nearWallFields.C
|
||||
IOnearWallFields.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::processorField
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Writes a scalar field whose value is the local processor ID. Output
|
||||
field name is processorID.
|
||||
@ -34,7 +33,6 @@ Description
|
||||
SourceFiles
|
||||
processorField.C
|
||||
IOprocessorField.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::readFields
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Reads fields from the time folders and adds them to the mesh database
|
||||
for further post-processing.
|
||||
@ -34,7 +33,6 @@ Description
|
||||
SourceFiles
|
||||
readFields.C
|
||||
IOreadFields.H
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,11 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::regionSizeDistribution
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
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.
|
||||
@ -36,7 +35,6 @@ Description
|
||||
|
||||
SourceFiles
|
||||
regionSizeDistribution.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,18 +21,16 @@ 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 grpFieldFunctionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::streamLine
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Generation of streamlines. Samples along track of passive particle.
|
||||
|
||||
SourceFiles
|
||||
streamLine.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user