diff --git a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H index 0199838eab..b7298b5a18 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.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,7 @@ Class Foam::directionMixedFvPatchField Description - Foam::directionMixedFvPatchField + Base class for direction-mixed boundary conditions. SourceFiles directionMixedFvPatchField.C @@ -43,7 +43,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class directionMixedFvPatch Declaration + Class directionMixedFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index cdf83f486a..4eeda602a2 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.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,27 @@ Class Foam::fixedGradientFvPatchField Description - Foam::fixedGradientFvPatchField + This boundary condition supplies a fixed gradient condition, such that + the patch values are calculated using: + + \f[ + values = int + gradient/delta + \f] + + where + \var values = patch values + \var int = internal field values + \var gradient = gradient (user-specified) + \var delta = inverse distance from patch face centre to cell centre + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedGradient; + gradient uniform 0; + } + \endverbatim SourceFiles fixedGradientFvPatchField.C @@ -43,7 +63,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedGradientFvPatch Declaration + Class fixedGradientFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index c3ba07477d..4ccafd8593 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -25,7 +25,21 @@ Class Foam::cyclicFvPatchField Description - Foam::cyclicFvPatchField + This boundary condition enforces a cyclic condition between a pair of + boundaries. + + \note + The patches must be topologically similar, i.e. if the owner patch is + transformed to the neighbour patch, the patches should be identical (or + very similar). + + Example of the boundary condition specification: + \verbatim + myPatch + { + type cyclic; + } + \endverbatim SourceFiles cyclicFvPatchField.C @@ -45,7 +59,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class cyclicFvPatch Declaration + Class cyclicFvPatch Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index 933a865f30..b80ac1fd54 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -25,7 +25,22 @@ Class Foam::cyclicAMIFvPatchField Description - Foam::cyclicAMIFvPatchField + This boundary condition enforces a cyclic condition between a pair of + boundaries, whereby communication between the patches is performed using + an arbitrary mesh interface (AMI) interpolation. + + \note + The outer boundary of the patch pairs must be similar, i.e. if the owner + patch is transformed to the neighbour patch, the outer perimiter of each + patch should be identical (or very similar). + + Example of the boundary condition specification: + \verbatim + myPatch + { + type cyclicAMI; + } + \endverbatim SourceFiles cyclicAMIFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index dd76378011..f3a52d9fcf 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.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,18 @@ Class Foam::emptyFvPatchField Description - Foam::emptyFvPatchField + This boundary condition provides an 'empty' condition for reduced + dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to + patches whose normal is aligned to geometric directions that do not + constitue solution directions. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type empty; + } + \endverbatim SourceFiles emptyFvPatchField.C @@ -44,7 +55,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class emptyFvPatch Declaration + Class emptyFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index e5aa2621ac..6bf3cb06ee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -92,7 +92,7 @@ class dynamicCodeContext; class IOdictionary; /*---------------------------------------------------------------------------*\ - Class codedFixedValueFvPatch Declaration + Class codedFixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index a24326317d..c2841cd239 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -96,7 +96,7 @@ class dynamicCodeContext; class IOdictionary; /*---------------------------------------------------------------------------*\ - Class codedMixedFvPatch Declaration + Class codedMixedFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index de15affbc7..d5c6f8e489 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.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 @@ -26,8 +26,9 @@ Class Foam::cylindricalInletVelocityFvPatchVectorField Description - Describes an inlet vector boundary condition in cylindrical coordinates - given a central axis, central point, rpm, axial and radial velocity. + This boundary condition describes an inlet vector boundary condition in + cylindrical co-ordinates given a central axis, central point, rpm, axial + and radial velocity. Example of the boundary condition specification: \verbatim @@ -36,15 +37,15 @@ Description type cylindricalInletVelocity; axis (0 0 1); centre (0 0 0); - axialVelocity constant 30; - radialVelocity constant -10; - rpm constant 100; + axialVelocity constant 30; // axial velocity [m/s] + radialVelocity constant -10; // radial velocity [m/s] + rpm constant 100; // revolutions per minute } \endverbatim - The axialVelocity, radialVelocity and rpm entries are DataEntry types, able - to describe time varying functions. The example above gives the usage for - supplying constant values. + The \c axialVelocity, \c radialVelocity and \c rpm entries are DataEntry + types, able to describe time varying functions. The example above gives + the usage for supplying constant values. SourceFiles cylindricalInletVelocityFvPatchVectorField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index b3799c2bd9..bad95b3a7f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -25,17 +25,20 @@ Class Foam::fanFvPatchField Description - Jump boundary condition. Operates on cyclic. Jump specified as a DataEntry. - (table, fileTable, csv etc.) + This boundary condition supplies a jump condition, using the \c cyclic + condition as a base. + + The jump is specified as a \c DataEntry type, to enable the use of, e.g. + contant, polynomial, table values. Example of the boundary condition specification: \verbatim - fan_half0 + myPatch { type fan; - patchType cyclic; - jump uniform 0; - jumpTable csvFile; + patchType cyclic; // specify \c cyclic + jump uniform 0; // current jump value + jumpTable csvFile; // jump specification csvFileCoeffs { hasHeaderLine 1; @@ -48,20 +51,13 @@ Description } \endverbatim + The above example shows the use of a CSV file to specify the jump. - Backwards compatibility: if the 'f' keyword is detected it assumes - it is a power of the flowrate. + \note + The underlying \c patchType should be set to \c cyclic - \verbatim - fan_half0 - { - type fan; - patchType cyclic; - jump uniform 0; - f 2(100 -0.1); - value uniform 0; - } - \endverbatim +SeeAlso + Foam::DataEntry SourceFiles fanFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index 9720684193..ed3b1c0237 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.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,13 @@ Class Foam::fanPressureFvPatchScalarField Description - Assigns pressure inlet or outlet total pressure condition for a fan. + This boundary condition can be applied to assign either a pressure inlet + or outlet total pressure condition for a fan. User specifies: - - pressure drop vs volumetric flow rate table (fan curve) file name; - - direction of normal flow through the fan, in or out; - - total pressure of the environment. + \li pressure drop vs volumetric flow rate table (fan curve) file name; + \li direction of normal flow through the fan, in or out; + \li total pressure of the environment. Example of the boundary condition specification: \verbatim @@ -56,7 +57,8 @@ Description \endverbatim See Also - Foam::totalPressureFvPatchScalarField and + Foam::fanFvPatchField + Foam::totalPressureFvPatchScalarField Foam::interpolationTable SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index de8f837abd..8fbe5091b9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -25,14 +25,31 @@ Class Foam::fixedFluxPressureFvPatchScalarField Description - Adjusts the pressure gradient such that the flux on the boundary is that - specified by the velocity boundary condition. + 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 (phi - phiHbyA), both of which are looked-up from the database as is - the pressure diffusivity Dp used to calculate the gradient. + 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: - The names of the phi, phiHbyA and Dp fields may be optionally specified. + \f[ + grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} + \f] + + where + \var Sf = patch face areas + + Example of the boundary condition specification: + \verbatim + myPatch + { + type externalWallHeatFluxTemperature; + phiHbyA phiHbyA; // predicted flux field (default = phiHbyA) + phi phi; // flux field (default = phi) + rho rho; // density field (default = rho) + Dp Dp; // pressure diffusivity field (default = Dp) + } + \endverbatim SourceFiles fixedFluxPressureFvPatchScalarField.C @@ -52,7 +69,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedFluxPressureFvPatch Declaration + Class fixedFluxPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class fixedFluxPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index cd27459a94..10fac6b767 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.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,26 @@ Class Foam::fixedInternalValueFvPatchField Description - Boundary condition providing mechanism to set boundary (cell) values - directly into a matrix, i.e. to set a constraint condition. Default + This boundary condition provides a mechanism to set boundary (cell) values + directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition. + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedInternalValue; + vakue uniform 0; // place holder + } + \endverbatim + + This is used as a base for conditions such as the turbulence \c epsilon + wall function, which applies a near-wall constraint for high Reynolds + number flows. + +SeeAlso + Foam::epsilonWallFunctionFvPatchScalarField + SourceFiles fixedInternalValueFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index c746b975cf..2bca8d534b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.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,11 @@ Class Foam::fixedJumpFvPatchField Description - Base class for "jump" of a field + Base class for "jump" of a field - not used directly + +SeeAlso + Foam::fanFvPatchScalarField + Foam::fanPressureFvPatchScalarField SourceFiles fixedJumpFvPatchField.C @@ -62,7 +66,6 @@ protected: public: - // Constructors //- Construct from patch and internal field diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 3a59c98f4e..94cc081b4e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.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,16 @@ Class Foam::fixedNormalSlipFvPatchField Description - Foam::fixedNormalSlipFvPatchField + This boundary condition sets the patch-normal component to a fixed value. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedNormalSlip; + fixedValue uniform 0; // example entry for a scalar field + } + \endverbatim SourceFiles fixedNormalSlipFvPatchField.C @@ -43,7 +52,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedNormalSlipFvPatch Declaration + Class fixedNormalSlipFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H index 5f3446c182..503b023f95 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.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,33 @@ Class Foam::filmPyrolysisTemperatureCoupledFvPatchScalarField Description - Temperature boundary condition for patches on the primary region: + This boundary condition is designed to be used in conjunction with surface + film and pyrolysis modelling. It provides a temperature boundary condition + for patches on the primary region based on whether the patch is seen to + be 'wet', specified by: - - where the film height > height threshold value: - apply film surface temperature values - - else - apply pyrolysis surface temperature values + \f[ + delta > delta_wet + \f] + + where + \var delta = film height [m] + \var delta_wet = film height above which the surface is considered wet + + \li if the patch is wet, the temperature is set using the film temperature + \li otherwise, it is set using pyrolysis temperature + + Example of the boundary condition specification: + \verbatim + myPatch + { + type filmPyrolysisTemperatureCoupled; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + deltaWet 1e-4; // threshold height for 'wet' film + value uniform 300; // initial temperature / [K] + } + \endverbatim SourceFiles filmPyrolysisTemperatureCoupledFvPatchScalarField.C @@ -63,7 +84,7 @@ class filmPyrolysisTemperatureCoupledFvPatchScalarField //- Name of density field word rhoName_; - //- Film height threshold beyond which it is considered 'wet' + //- Film height threshold beyond which it is considered 'wet' [m] scalar deltaWet_; diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H index 8b654ec168..c7c4c5d24b 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.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,33 @@ Class Foam::filmPyrolysisVelocityCoupledFvPatchVectorField Description - Velocity boundary condition for patches on the primary region: + This boundary condition is designed to be used in conjunction with surface + film and pyrolysis modelling. It provides a velocity boundary condition + for patches on the primary region based on whether the patch is seen to + be 'wet', specified by: - - where the film height > height threshold value: - apply film surface velocity values - - else - apply pyrolysis out-gassing velocity values + \f[ + delta > delta_wet + \f] + + where + \var delta = film height [m] + \var delta_wet = film height above which the surface is considered wet + + \li if the patch is wet, the velocity is set using the film velocity + \li otherwise, it is set using pyrolysis out-gassing velocity + + Example of the boundary condition specification: + \verbatim + myPatch + { + type filmPyrolysisVelocityCoupled; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + deltaWet 1e-4; // threshold height for 'wet' film + value uniform (0 0 0); // initial velocity / [m/s] + } + \endverbatim SourceFiles filmPyrolysisVelocityCoupledFvPatchVectorField.C diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index 194861cd92..571b597204 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.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,9 +25,34 @@ Class Foam::filmHeightInletVelocityFvPatchVectorField Description - Velocity inlet boundary condition for patches where the film height is - specified. The inflow velocity is obtained from the flux with a direction - normal to the patch faces. + This boundary condition is designed to be used in conjunction with + surface film modelling. It provides a velocity inlet boundary condition + for patches where the film height is specified. The inflow velocity is + obtained from the flux with a direction normal to the patch faces using: + + \f[ + Up = \frac{n*phi}{rho*mag(Sf)*delta} + \f] + + where + \var Up = patch velocity [m/s] + \var n = patch normal vector + \var phi = mass flux [kg/s] + \var rho = density [kg/m3] + \var Sf = patch face area vectors [m2] + \var delta = film height [m] + + Example of the boundary condition specification: + \verbatim + myPatch + { + type filmHeightInletVelocity; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + deltaf deltaf; // name of height field (default = deltaf) + value uniform (0 0 0); // initial velocity / [m/s] + } + \endverbatim SourceFiles filmHeightInletVelocityFvPatchVectorField.C diff --git a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index 9b461334cb..1230136b73 100644 --- a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.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,26 +25,38 @@ Class externalWallHeatFluxTemperatureFvPatchScalarField Description - Heat flux boundary condition for temperature on external wall. + This boundary condition supplies a heat flux condition for temperature + on an external wall. - If h and Ta are specified then fixed_heat_transfer_coefficient mode is used - If q is specified then fixed_heat_flux is used. + The condition can operate in two modes: + \li fixed heat transfer coefficient: supply h and Ta + \li fixed heat flux: supply q - Example usage: - myWallPatch + where + \var h = heat transfer coefficient [W/m2/K] + \var Ta = ambient temperature [K] + \var q = heat flux [W/m2] + + The thermal conductivity, \c kappa, can either be retrieved from the + mesh database using the \c lookup option, or from a \c solidThermo + thermophysical package. + + Example of the boundary condition specification: + \verbatim + myPatch { type externalWallHeatFluxTemperature; kappa solidThermo; // solidThermo or lookup - q uniform 1000; // Heat flux / [W/m2] - Ta uniform 300.0; // Tambient temperature /[K] - h uniform 10.0; // Heat transfer coeff /[W/Km2] - value uniform 300.0; // Initial temperature / [K] + q uniform 1000; // heat flux / [W/m2] + Ta uniform 300.0; // ambient temperature /[K] + h uniform 10.0; // heat transfer coeff /[W/Km2] + value uniform 300.0; // initial temperature / [K] kappaName none; } + \endverbatim -Note: - Only the pair h, Ta or q can be specified in the dictionary. - + \note + Only supply \h an \c Ta, or \c q in the dictionary (see above) SourceFiles externalWallHeatFluxTemperatureFvPatchScalarField.C @@ -178,6 +190,7 @@ public: //- Update the coefficients associated with the patch field virtual void updateCoeffs(); + // I-O //- Write diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index b95f74dd92..f7649261c3 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -25,9 +25,29 @@ Class Foam::incompressible::RASModels::epsilonWallFunctionFvPatchScalarField Description - Boundary condition for epsilon when using wall functions - - calculates epsilon and G - - epsilon values added directly into the matrix to act as a constraint + This boundary condition provides a turbulence dissipation wall function + condition for high Reynolds number, turbulent flow cases. + + The condition can be applied to wall boundaries, whereby it + \li calculates \c epsilon and \c G + \li inserts near wall epsilon values directly into the epsilon equation + to act as a constraint + + where + \var epsilon = turblence dissipation field + \var G = turblence generation field + + Example of the boundary condition specification: + \verbatim + myPatch + { + type epsilonWallFunction; + G G; // turblence generation field (default = G) + Cmu 0.09; // Cmu model coefficient (default = 0.09) + kappa 0.41; // Von Karman constant (default = 0.41) + E 9.8; // E coefficient (default = 9.8) + } + \endverbatim SourceFiles epsilonWallFunctionFvPatchScalarField.C @@ -72,7 +92,6 @@ protected: //- E coefficient scalar E_; - //- Y+ at the edge of the laminar sublayer scalar yPlusLam_;