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: Boundary condition doxygen documentation updates

Browse Source
This commit is contained in:
andy
2012-07-06 14:48:30 +01:00
parent 96179eb560
commit 5b364fae9b
8 changed files with 163 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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>

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

@ -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

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

@ -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

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

@ -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_;

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

@ -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>

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

@ -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

10
src/genericPatchFields/genericFvPatchField/genericFvPatchField.H
View File

@ -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

23
src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H
View File

@ -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