diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H
index 65e7abea4ab6d0b7b36d0f2353bc6664ecdd59ce..9b787760d2c53c094226b7a2eb5c3b89c7451b17 100644
--- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,7 +25,17 @@ Class
Foam::fixedValueFvPatchField
Description
- Foam::fixedValueFvPatchField
+ This boundary condition supplies a fixed value constraint, and is the base
+ class for a number of other boundary conditions.
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type fixedValue;
+ value uniform 0; // example for scalar field usage
+ }
+ \endverbatim
SourceFiles
fixedValueFvPatchField.C
@@ -43,7 +53,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class fixedValueFvPatch Declaration
+ Class fixedValueFvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
index a27409e94b9f29ee4c2df79f8ce880862a3946a1..67b4184da06cebf213c5d048fdc4a690348ea98d 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,12 +25,25 @@ Class
Foam::fixedPressureCompressibleDensityFvPatchScalarField
Description
- Calculate compressible density as a function of pressure and fluid
- properties.
+ This boundary condition calculates a (liquid) compressible density as a
+ function of pressure and fluid properties:
+
+ \f[
+ rho = rholSat + psil*(p - pSat)
+ \f]
+
+ where
+ \var rho = density [kg/m3]
+ \var rholSat = saturation liquid density
+ \var p = pressure [Pa]
+ \var pSat = saturation pressure [Pa]
+
+ The variables \c rholSat, \c pSat and \c psil are retrieved from the
+ \c thermodynamicProperties dictionary.
Example of the boundary condition specification:
\verbatim
- inlet
+ myPatch
{
type fixedPressureCompressibleDensity;
p p; // Name of static pressure field
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
index a4b48c762985683f97f69192740423473d0ac503..e0564e3a5a0f9b343573890aa55ceae683f58214 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
@@ -25,31 +25,42 @@ Class
Foam::flowRateInletVelocityFvPatchVectorField
Description
- Describes a volumetric/mass flow normal vector boundary condition by its
- magnitude as an integral over its area.
+ This boundary condition provides a velocity boundary condition, derived
+ from the flux (volumetric or mass-based), whose direction is assumed
+ to be normal to the patch.
The basis of the patch (volumetric or mass) is determined by the
- dimensions of the flux, phi.
+ dimensions of the flux, \c phi, and the value of the density field name,
+ \c rhoName entry.
- If the flux is mass-based
- - the current density is used to correct the velocity
- - volumetric flow rate can be applied by setting the 'rho' entry to 'none'
+ For a mass-based flux:
+ \li if \c rhoName is a valid density field name, the flow rate is in kg/s
+ \li if \c rhoName is "none" the flow rate is in m3/s
+
+ For a volumetric-based flux:
+ \li the flow rate is in m3/s
Example of the boundary condition specification:
\verbatim
- inlet
- {
- type flowRateInletVelocity;
- flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s]
- rho rho; // none | rho [m3/s or kg/s]
- value uniform (0 0 0); // placeholder
- }
+ myPatch
+ {
+ type flowRateInletVelocity;
+ flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s]
+ rho rho; // none | rho [m3/s or kg/s]
+ value uniform (0 0 0); // placeholder
+ }
\endverbatim
-Note
- - The value is positive inwards
- - May not work correctly for transonic inlets
- - Strange behaviour with potentialFoam since the U equation is not solved
+ The \c flowRate entry is a \c DataEntry type, meaning that it can be
+ specified as constant, a polynomial fuction of time, and ...
+
+ \note
+ \li the value is positive into the domain (as an inlet)
+ \li may not work correctly for transonic inlets
+ \li strange behaviour with potentialFoam since the U equation is not solved
+
+SeeAlso
+ Foam::DataEntry
SourceFiles
flowRateInletVelocityFvPatchVectorField.C
@@ -67,7 +78,7 @@ SourceFiles
namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class flowRateInletVelocityFvPatch Declaration
+ Class flowRateInletVelocityFvPatchVectorField Declaration
\*---------------------------------------------------------------------------*/
class flowRateInletVelocityFvPatchVectorField
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
index 6631d205b47be2f4ca988107ae04d362c259e6b1..00ea99bc37690e2c080279963c22d426c46fda6c 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,10 +25,38 @@ Class
Foam::fluxCorrectedVelocityFvPatchVectorField
Description
- Velocity outlet boundary condition for patches where the pressure is
- specified. The outflow velocity is obtained by "zeroGradient" and then
- corrected from the flux. If reverse flow is possible or expected use
- the "pressureInletOutletVelocityFvPatchVectorField" BC instead.
+ This boundary condition provides a velocity outlet boundary condition for
+ patches where the pressure is specified. The outflow velocity is obtained
+ by "zeroGradient" and then corrected from the flux:
+
+ \f[
+ Up = Uc - n*(n.Uc) + n*phi/mag(Sf)
+ \f]
+
+ where
+ \var Up = velocity at the patch [m/s]
+ \var Uc = velocity in cells adjacent to the patch [m/s]
+ \var n = patch normal vectors
+ \var phi = flux at the patch [m3/s or kg/s]
+ \var Sf = patch face area vectors [m2]
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type fluxCorrectedVelocity;
+ phi phi; // name of flux field (default = phi)
+ rho rho; // name of density field (default = rho)
+ }
+ \endverbatim
+
+ \note
+ If reverse flow is possible or expected use the
+ pressureInletOutletVelocity condition instead.
+
+SeeAlso
+ Foam::zeroGradientFvPatchField
+ Foam::pressureInletOutletVelocityFvPatchVectorField
SourceFiles
fluxCorrectedVelocityFvPatchVectorField.C
@@ -47,7 +75,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class fluxCorrectedVelocityFvPatch Declaration
+ Class fluxCorrectedVelocityFvPatchVectorField Declaration
\*---------------------------------------------------------------------------*/
class fluxCorrectedVelocityFvPatchVectorField
@@ -56,7 +84,10 @@ class fluxCorrectedVelocityFvPatchVectorField
{
// Private data
+ //- Name of flux field
word phiName_;
+
+ //- Name of density field
word rhoName_;
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
index 50f3d136f0eb4ce95bfcb1f87c4c7e048eb75e2b..d6936c01c9b9d2112745f0f1e32e9823b0df871d 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,7 +25,23 @@ Class
Foam::freestreamFvPatchField
Description
- Foam::freestreamFvPatchField
+ This boundary condition provides a free-stream condition. It is a 'mixed'
+ condition derived from the \c inletOutlet condition, whereby the mode of
+ operation switches between fixed (free stream) value and zero gradient
+ based on the sign of the flux.
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type freestream;
+ phi phi; // name of the flux field (default = phi)
+ }
+ \endverbatim
+
+SeeAlso
+ Foam::mixedFvPatchField
+ Foam::inletOutletFvPatchField
SourceFiles
freestreamFvPatchField.C
@@ -43,7 +59,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class freestreamFvPatch Declaration
+ Class freestreamFvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
index 6323b678d7d165b48177720e22b9bdfd060bf6f4..6107208e19b9a3e954cf99a1d7dc4856c6e05bcb 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,7 +25,24 @@ Class
Foam::freestreamPressureFvPatchScalarField
Description
- Foam::freestreamPressureFvPatchScalarField
+ This boundary condition provides a free-stream condition for pressure.
+ It is a zero-gradient condition that constrains the flux across the patch
+ based on the free-stream velocity.
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type freestreamPressure;
+ }
+ \endverbatim
+
+ \note
+ This condition is designed to operate with a freestream velocity condition
+
+SeeAlso
+ Foam::zeroGradientFvPatchField
+ Foam::freestreamFvPatchField
SourceFiles
freestreamPressureFvPatchScalarField.C
@@ -44,7 +61,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class freestreamPressureFvPatch Declaration
+ Class freestreamPressureFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class freestreamPressureFvPatchScalarField
diff --git a/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H b/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H
index 3236c3f2b9fce7535e412b60074365651f8deb26..c032a32fc271966e1fd8dbff68ee6ee40e5c3285 100644
--- a/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H
+++ b/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,8 +25,12 @@ Class
Foam::genericFvPatchField
Description
- A generic version of calculatedFvPatchField, useful as a fallback for
- handling unknown patch types.
+ This boundary condition provides a generic version of the \c calculated
+ condition, useful as a fallback for handling unknown patch types. Not
+ generally applicable as a user-specified condition.
+
+SeeAlso
+ Foam::calculatedFvPatchField
SourceFiles
genericFvPatchField.C
diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H
index 2199242b59204e986489e4931eb2982a05bc8252..4eab608b80738965b2faf33b28ee71c9c95297fd 100644
--- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H
+++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,7 +25,26 @@ Class
Foam::greyDiffusiveRadiationMixedFvPatchScalarField
Description
- Radiation temperature specified
+ This boundary condition provides a grey-diffuse condition for radiation
+ intensity, \c I, for use with the finite-volume discrete-ordinates model
+ (fvDOM), in which the radiation temperature is retrieved from the
+ temperature field boundary condition.
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type greyDiffusiveRadiation;
+ T T; // name of temperature field
+ emissivityMode solidThermo; // solidThermo | lookup
+ value uniform 0; // initial value
+ }
+ \endverbatim
+
+SeeAlso
+ Foam::radiation::fvDOM
+ Foam::radiationCoupledBase
+ Foam::mixedFvPatchField
SourceFiles
greyDiffusiveRadiationMixedFvPatchScalarField.C