This boundary condition provides a wall constraint on the turbulent kinetic energy dissipation rate (i.e. epsilon
) and the turbulent kinetic energy production contribution (i.e. G
) for atmospheric boundary layer modelling.
More...
Public Member Functions | |
TypeName ("atmEpsilonWallFunction") | |
Runtime type information. More... | |
atmEpsilonWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &) | |
Construct from patch and internal field. More... | |
atmEpsilonWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
atmEpsilonWallFunctionFvPatchScalarField (const atmEpsilonWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping given atmEpsilonWallFunctionFvPatchScalarField onto a new patch. More... | |
atmEpsilonWallFunctionFvPatchScalarField (const atmEpsilonWallFunctionFvPatchScalarField &) | |
Construct as copy. More... | |
virtual tmp< fvPatchScalarField > | clone () const |
Construct and return a clone. More... | |
atmEpsilonWallFunctionFvPatchScalarField (const atmEpsilonWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual tmp< fvPatchScalarField > | clone (const DimensionedField< scalar, volMesh > &iF) const |
Construct and return a clone setting internal field reference. More... | |
virtual | ~atmEpsilonWallFunctionFvPatchScalarField ()=default |
Destructor. More... | |
virtual void | autoMap (const fvPatchFieldMapper &) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const fvPatchScalarField &, const labelList &) |
Reverse map the given fvPatchField onto this fvPatchField. More... | |
virtual void | write (Ostream &) const |
Write. More... | |
Public Member Functions inherited from epsilonWallFunctionFvPatchScalarField | |
TypeName ("epsilonWallFunction") | |
Runtime type information. More... | |
epsilonWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &) | |
Construct from patch and internal field. More... | |
epsilonWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
epsilonWallFunctionFvPatchScalarField (const epsilonWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping given epsilonWallFunctionFvPatchScalarField onto a new patch. More... | |
epsilonWallFunctionFvPatchScalarField (const epsilonWallFunctionFvPatchScalarField &) | |
Construct as copy. More... | |
epsilonWallFunctionFvPatchScalarField (const epsilonWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual | ~epsilonWallFunctionFvPatchScalarField ()=default |
Destructor. More... | |
scalarField & | G (bool init=false) |
Return non-const access to the master's G field. More... | |
scalarField & | epsilon (bool init=false) |
Return non-const access to the master's epsilon field. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
virtual void | updateWeightedCoeffs (const scalarField &weights) |
Update the coefficients associated with the patch field. More... | |
virtual void | manipulateMatrix (fvMatrix< scalar > &matrix) |
Manipulate matrix. More... | |
virtual void | manipulateMatrix (fvMatrix< scalar > &matrix, const scalarField &weights) |
Manipulate matrix with given weights. More... | |
Public Member Functions inherited from fixedValueFvPatchField< scalar > | |
TypeName ("fixedValue") | |
Runtime type information. More... | |
fixedValueFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &) | |
Construct from patch and internal field. More... | |
fixedValueFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const scalar &value) | |
Construct from patch, internal field and value. More... | |
fixedValueFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &, const bool valueRequired=true) | |
Construct from patch, internal field and dictionary. More... | |
fixedValueFvPatchField (const fixedValueFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping the given fixedValueFvPatchField<Type> More... | |
fixedValueFvPatchField (const fixedValueFvPatchField< scalar > &) | |
Construct as copy. More... | |
fixedValueFvPatchField (const fixedValueFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual bool | fixesValue () const |
Return true if this patch field fixes a value. More... | |
virtual bool | assignable () const |
Return false: this patch field is not altered by assignment. More... | |
virtual tmp< Field< scalar > > | valueInternalCoeffs (const tmp< scalarField > &) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< scalar > > | valueBoundaryCoeffs (const tmp< scalarField > &) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual tmp< Field< scalar > > | gradientInternalCoeffs () const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< scalar > > | gradientBoundaryCoeffs () const |
Return the matrix source coefficients corresponding to the. More... | |
virtual void | operator= (const UList< scalar > &) |
virtual void | operator= (const fvPatchField< scalar > &) |
virtual void | operator= (const scalar &) |
virtual void | operator+= (const fvPatchField< scalar > &) |
virtual void | operator+= (const Field< scalar > &) |
virtual void | operator+= (const scalar &) |
virtual void | operator-= (const fvPatchField< scalar > &) |
virtual void | operator-= (const Field< scalar > &) |
virtual void | operator-= (const scalar &) |
virtual void | operator*= (const fvPatchField< scalar > &) |
virtual void | operator*= (const Field< scalar > &) |
virtual void | operator*= (const scalar) |
virtual void | operator/= (const fvPatchField< scalar > &) |
virtual void | operator/= (const Field< scalar > &) |
virtual void | operator/= (const scalar) |
Public Member Functions inherited from fvPatchField< scalar > | |
declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< scalar, volMesh > &iF),(p, iF)) | |
declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< scalar > &ptf, const fvPatch &p, const DimensionedField< scalar, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m)) | |
declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< scalar, volMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &) | |
Construct from patch and internal field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const scalar &value) | |
Construct from patch, internal field and value. More... | |
fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const word &patchType) | |
Construct from patch and internal field and patch type. More... | |
fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const Field< scalar > &) | |
Construct from patch and internal field and patch field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &, const bool valueRequired=true) | |
Construct from patch, internal field and dictionary. More... | |
fvPatchField (const fvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping the given fvPatchField onto a new patch. More... | |
fvPatchField (const fvPatchField< scalar > &) | |
Construct as copy. More... | |
fvPatchField (const fvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
Foam::tmp< Foam::fvPatchField< scalar > > | NewCalculatedType (const fvPatchField< Type2 > &pf) |
virtual | ~fvPatchField ()=default |
Destructor. More... | |
virtual bool | coupled () const |
True if this patch field is coupled. More... | |
const DimensionedField< scalar, volMesh > & | internalField () const noexcept |
Return dimensioned internal field reference. More... | |
const Field< scalar > & | primitiveField () const noexcept |
Return internal field reference. More... | |
virtual tmp< Field< scalar > > | snGrad () const |
Return patch-normal gradient. More... | |
virtual tmp< Field< scalar > > | snGrad (const scalarField &deltaCoeffs) const |
Return patch-normal gradient for coupled-patches. More... | |
virtual tmp< Field< scalar > > | patchInternalField () const |
Return internal field next to patch as patch field. More... | |
virtual void | patchInternalField (Field< scalar > &) const |
Return internal field next to patch as patch field. More... | |
virtual tmp< Field< scalar > > | patchNeighbourField () const |
Return patchField on the opposite patch of a coupled patch. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Initialise the evaluation of the patch field. More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Evaluate the patch field, sets Updated to false. More... | |
virtual tmp< Field< scalar > > | valueInternalCoeffs (const tmp< Field< scalar >> &) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< scalar > > | valueBoundaryCoeffs (const tmp< Field< scalar >> &) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual tmp< Field< scalar > > | gradientInternalCoeffs (const scalarField &deltaCoeffs) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< scalar > > | gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual void | manipulateMatrix (fvMatrix< scalar > &matrix, const label iMatrix, const direction cmp) |
Manipulate fvMatrix. More... | |
void | check (const fvPatchField< scalar > &) const |
Check fvPatchField<Type> against given fvPatchField<Type> More... | |
virtual void | operator== (const fvPatchField< scalar > &) |
virtual void | operator== (const Field< scalar > &) |
virtual void | operator== (const scalar &) |
Public Member Functions inherited from fvPatchFieldBase | |
TypeName ("fvPatchField") | |
Runtime type information. More... | |
fvPatchFieldBase (const fvPatch &p) | |
Construct from patch. More... | |
fvPatchFieldBase (const fvPatch &p, const word &patchType) | |
Construct from patch and patch type. More... | |
fvPatchFieldBase (const fvPatch &p, const dictionary &dict) | |
Construct from patch and dictionary. More... | |
fvPatchFieldBase (const fvPatchFieldBase &rhs, const fvPatch &p) | |
Copy construct with new patch. More... | |
fvPatchFieldBase (const fvPatchFieldBase &rhs) | |
Copy construct. More... | |
virtual | ~fvPatchFieldBase ()=default |
Destructor. More... | |
const objectRegistry & | db () const |
The associated objectRegistry. More... | |
const fvPatch & | patch () const noexcept |
Return the patch. More... | |
const word & | patchType () const noexcept |
The optional patch type. More... | |
word & | patchType () noexcept |
The optional patch type. More... | |
bool | updated () const noexcept |
True if the boundary condition has already been updated. More... | |
bool | manipulatedMatrix () const noexcept |
True if the matrix has already been manipulated. More... | |
bool | useImplicit () const noexcept |
Use implicit formulation for coupled patches only. More... | |
bool | useImplicit (bool on) noexcept |
Set useImplicit on/off. More... | |
void | checkPatch (const fvPatchFieldBase &rhs) const |
Check that patches are identical. More... | |
Public Member Functions inherited from Field< scalar > | |
constexpr | Field () noexcept |
Default construct. More... | |
Field (const label len) | |
Construct given size. More... | |
Field (const label len, const scalar &val) | |
Construct given size and initial value. More... | |
Field (const label len, const Foam::zero) | |
Construct given size and initial values of zero. More... | |
Field (const Foam::one, const scalar &val) | |
Construct with length=1, copying the value as the only content. More... | |
Field (const Foam::one, scalar &&val) | |
Construct with length=1, moving the value as the only content. More... | |
Field (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
Field (const Field< scalar > &fld) | |
Copy construct. More... | |
Field (const UList< scalar > &list) | |
Copy construct from UList<Type> More... | |
Field (const IndirectListBase< scalar, Addr > &list) | |
Copy construct from IndirectList. More... | |
Field (Field< scalar > &&fld) | |
Move construct from Field. More... | |
Field (List< scalar > &&list) | |
Move construct from List. More... | |
Field (DynamicList< scalar, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
Field (const UList< scalar > &mapF, const labelUList &mapAddressing) | |
Construct by 1 to 1 mapping from the given field. More... | |
Field (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing) | |
Construct by 1 to 1 mapping from the given tmp field. More... | |
Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given field. More... | |
Field (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given tmp field. More... | |
Field (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. More... | |
Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More... | |
Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More... | |
Field (Field< scalar > &fld, bool reuse) | |
Copy construct or re-use as specified. More... | |
Field (const tmp< Field< scalar >> &tfld) | |
Copy or move construct from tmp. More... | |
Field (Istream &is) | |
Construct from Istream. More... | |
Field (const entry &e, const label len) | |
Construct from a dictionary (primitive) entry. More... | |
Field (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) | |
Construct from lookup of a dictionary (primitive) entry. More... | |
tmp< Field< scalar > > | clone () const |
Clone. More... | |
void | assign (const entry &e, const label len) |
Assign from a dictionary (primitive) entry. More... | |
void | assign (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) |
Assign from lookup of a dictionary (primitive) entry. More... | |
void | map (const UList< scalar > &mapF, const labelUList &mapAddressing) |
1 to 1 map from the given field More... | |
void | map (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing) |
1 to 1 map from the given tmp field More... | |
void | map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given field. More... | |
void | map (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given tmp field. More... | |
void | map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given field. More... | |
void | map (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given tmp field. More... | |
void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
Map from self. More... | |
void | rmap (const UList< scalar > &mapF, const labelUList &mapAddressing) |
1 to 1 reverse-map from the given field More... | |
void | rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing) |
1 to 1 reverse-map from the given tmp field More... | |
void | rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
Interpolative reverse map from the given field. More... | |
void | rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
Interpolative reverse map from the given tmp field. More... | |
void | negate () |
Inplace negate this field (negative). More... | |
void | normalise () |
Inplace normalise this field. Generally a no-op except for vector fields. More... | |
void | normalise () |
void | normalise () |
void | normalise () |
Inplace normalise (float) vector field. More... | |
void | normalise () |
Inplace normalise (double) vector field. More... | |
tmp< Field< cmptType > > | component (const direction) const |
Return a component field of the field. More... | |
void | replace (const direction, const UList< cmptType > &) |
Replace a component field of the field. More... | |
void | replace (const direction, const tmp< Field< cmptType >> &) |
Replace a component field of the field. More... | |
void | replace (const direction, const cmptType &) |
Replace a component field of the field. More... | |
VSForm | block (const label start) const |
tmp< Field< scalar > > | T () const |
Return the field transpose (only defined for second rank tensors) More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the field as a dictionary entry. More... | |
SubField< scalar > | slice (const label pos, label len=-1) |
Return SubField slice (non-const access) - no range checking. More... | |
const SubField< scalar > | slice (const label pos, label len=-1) const |
Return SubField slice (const access) - no range checking. More... | |
SubField< scalar > | slice (const labelRange &range) |
Return SubField slice (non-const access) - with range checking. More... | |
const SubField< scalar > | slice (const labelRange &range) const |
Return SubField slice (const access) - with range checking. More... | |
void | operator= (const Field< scalar > &) |
Copy assignment. More... | |
void | operator= (const tmp< Field< scalar >> &) |
void | operator= (const UList< scalar > &rhs) |
void | operator= (const SubField< scalar > &rhs) |
void | operator= (const IndirectListBase< scalar, Addr > &rhs) |
Copy assign from IndirectList. More... | |
void | operator= (Field< scalar > &&rhs) |
Move assignment. More... | |
void | operator= (List< scalar > &&rhs) |
void | operator= (DynamicList< scalar, SizeMin > &&rhs) |
void | operator= (const scalar &val) |
Value assignment. More... | |
void | operator= (const Foam::zero) |
void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
void | operator= (const tmp< Field > &rhs) |
void | operator+= (const UList< scalar > &) |
void | operator+= (const tmp< Field< scalar >> &) |
void | operator+= (const scalar &) |
void | operator-= (const UList< scalar > &) |
void | operator-= (const tmp< Field< scalar >> &) |
void | operator-= (const scalar &) |
void | operator*= (const UList< scalar > &) |
void | operator*= (const tmp< Field< scalar >> &) |
void | operator*= (const scalar &) |
void | operator/= (const UList< scalar > &) |
void | operator/= (const tmp< Field< scalar >> &) |
void | operator/= (const scalar &) |
Public Member Functions inherited from FieldBase | |
constexpr | FieldBase () noexcept |
Default construct. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | count () const noexcept |
Return the current reference count. More... | |
bool | unique () const noexcept |
Return true if the reference count is zero. More... | |
void | operator++ () noexcept |
Increment the reference count. More... | |
void | operator++ (int) noexcept |
Increment the reference count. More... | |
void | operator-- () noexcept |
Decrement the reference count. More... | |
void | operator-- (int) noexcept |
Decrement the reference count. More... | |
Public Member Functions inherited from List< scalar > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const scalar &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const scalar &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, scalar &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< scalar > &a) | |
Copy construct from list. More... | |
List (const UList< scalar > &a) | |
Copy construct contents from list. More... | |
List (List< scalar > &a, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< scalar > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< scalar > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< scalar, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< scalar > &list) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< scalar > &list) | |
Construct as copy of SLList<T> More... | |
List (const IndirectListBase< scalar, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< scalar > list) | |
Construct from an initializer list. More... | |
List (List< scalar > &&list) | |
Move construct from List. More... | |
List (DynamicList< scalar, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (SLList< scalar > &&list) | |
Move construct from SLList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< scalar > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const scalar &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const scalar &val) |
Alias for resize() More... | |
void | transfer (List< scalar > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< scalar, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
scalar & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
void | push_back (const scalar &val) |
Append an element at the end of the list. More... | |
void | push_back (scalar &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< scalar > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< scalar, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const scalar &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< scalar > &a) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< scalar > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const SLList< scalar > &list) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< scalar, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< scalar, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< scalar > list) |
Assignment to an initializer list. More... | |
void | operator= (const scalar &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< scalar > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< scalar, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SLList< scalar > &&list) |
Move assignment. Takes constant time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
Istream & | readList (Istream &is) |
void | shallowCopy (const UList< scalar > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const scalar &val) |
Append an element at the end of the list. More... | |
void | append (scalar &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< scalar > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< scalar, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const scalar &val) |
Append an element if not already in the list. More... | |
Public Member Functions inherited from UList< T > | |
UList (const UList< T > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (T *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const T & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
T & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const T & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
T & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const T * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
T * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
T & | front () |
Access first element of the list, position [0]. More... | |
const T & | front () const |
Access first element of the list. More... | |
T & | back () |
Access last element of the list, position [size()-1]. More... | |
const T & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
label | find (const T &val, label pos=0) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const T &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
bool | found (const T &val, label pos=0) const |
True if the value if found in the list. More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (const UList< T > &list) |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< T > &list) |
Copy elements of the given UList. Sizes must match! More... | |
template<class Addr > | |
void | deepCopy (const IndirectListBase< T, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< T > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< T > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< T > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< T > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
T & | operator[] (const label i) |
Return element of UList. More... | |
const T & | operator[] (const label i) const |
Return element of constant UList. More... | |
operator const Foam::List< T > & () const | |
Allow cast to a const List<T>&. More... | |
void | operator= (const T &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. More... | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
label | size () const noexcept |
The number of elements in the UList. More... | |
bool | empty () const noexcept |
True if the UList is empty (ie, size() is zero) More... | |
void | swap (UList< T > &list) |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< T > &a) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &a) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< T > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< T > &a) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &a) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &a) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
T & | first () |
Access first element of the list, position [0]. More... | |
const T & | first () const |
Access first element of the list. More... | |
T & | last () |
Access last element of the list, position [size()-1]. More... | |
const T & | last () const |
Access last element of the list, position [size()-1]. More... | |
template<> | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
template<> | |
Ostream & | writeList (Ostream &os, const label) const |
Specialized writeList for character lists which always uses binary format. More... | |
template<> | |
const bool & | operator[] (const label i) const |
template<> | |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
Ostream & | writeList (Ostream &os, const label) const |
template<> | |
Istream & | readList (Istream &is) |
Protected Member Functions | |
virtual void | calculate (const turbulenceModel &turbulence, const List< scalar > &cornerWeights, const fvPatch &patch, scalarField &G, scalarField &epsilon) |
Calculate the epsilon and G. More... | |
void | writeLocalEntries (Ostream &) const |
Write local wall function variables. More... | |
Protected Member Functions inherited from epsilonWallFunctionFvPatchScalarField | |
virtual void | setMaster () |
Set the master patch - master is responsible for updating all wall function patches. More... | |
virtual void | createAveragingWeights () |
Create the averaging weights for cells which are bounded by multiple wall function faces. More... | |
virtual epsilonWallFunctionFvPatchScalarField & | epsilonPatch (const label patchi) |
Helper function to return non-const access to an epsilon patch. More... | |
virtual void | calculateTurbulenceFields (const turbulenceModel &turbulence, scalarField &G0, scalarField &epsilon0) |
Main driver to calculate the turbulence fields. More... | |
virtual label & | master () |
Return non-const access to the master patch ID. More... | |
void | writeLocalEntries (Ostream &) const |
Write local wall function variables. More... | |
Protected Member Functions inherited from fvPatchFieldBase | |
virtual void | readDict (const dictionary &dict) |
Read dictionary entries. More... | |
void | setUpdated (bool state) noexcept |
Set updated state. More... | |
void | setManipulated (bool state) noexcept |
Set matrix manipulated state. More... | |
Protected Member Functions inherited from UList< T > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
UList< T > & | operator= (const UList< T > &)=delete |
No copy assignment (default: shallow copy) More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Specialized writeEntry for character lists which always uses binary format. More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Protected Attributes | |
autoPtr< PatchFunction1< scalar > > | z0_ |
Surface roughness length field [m]. More... | |
Protected Attributes inherited from epsilonWallFunctionFvPatchScalarField | |
const bool | lowReCorrection_ |
Apply low-Re correction term (default = no) More... | |
bool | initialised_ |
Initialised flag. More... | |
label | master_ |
Master patch ID. More... | |
wallFunctionCoefficients | wallCoeffs_ |
Wall-function coefficients. More... | |
scalarField | G_ |
Local copy of turbulence G field. More... | |
scalarField | epsilon_ |
Local copy of turbulence epsilon field. More... | |
List< List< scalar > > | cornerWeights_ |
List of averaging corner weights. More... | |
Additional Inherited Members | |
Public Types inherited from fvPatchField< scalar > | |
typedef DimensionedField< scalar, volMesh > | Internal |
The internal field type associated with the patch field. More... | |
typedef fvPatch | Patch |
The patch type for the patch field. More... | |
typedef calculatedFvPatchField< scalar > | Calculated |
Type for a calculated patch. More... | |
Public Types inherited from Field< scalar > | |
typedef pTraits< scalar >::cmptType | cmptType |
Component type. More... | |
typedef SubField< scalar > | subField |
Declare type of subField. More... | |
Public Types inherited from List< scalar > | |
typedef SubList< scalar > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
The value type the list contains. More... | |
typedef T * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const T * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef T & | reference |
The type used for storing into value_type objects. More... | |
typedef const T & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef T * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Static Public Member Functions inherited from fvPatchField< scalar > | |
static tmp< fvPatchField< scalar > > | New (const word &patchFieldType, const fvPatch &, const DimensionedField< scalar, volMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
static tmp< fvPatchField< scalar > > | New (const word &patchFieldType, const word &actualPatchType, const fvPatch &, const DimensionedField< scalar, volMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
static tmp< fvPatchField< scalar > > | New (const fvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &) |
Return a pointer to a new patchField created on freestore from. More... | |
static tmp< fvPatchField< scalar > > | New (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &) |
Return a pointer to a new patchField created on freestore. More... | |
static tmp< fvPatchField< scalar > > | NewCalculatedType (const fvPatch &) |
Return a pointer to a new calculatedFvPatchField created on. More... | |
static tmp< fvPatchField< scalar > > | NewCalculatedType (const fvPatchField< Type2 > &) |
Return a pointer to a new calculatedFvPatchField created on. More... | |
static const word & | calculatedType () |
The type name for calculated patch fields. More... | |
static const word & | zeroGradientType () |
The type name for zeroGradient patch fields. More... | |
Static Public Member Functions inherited from Field< scalar > | |
static const Field< scalar > & | null () |
Return nullObject reference Field. More... | |
static autoPtr< Field< scalar > > | New (Istream &is) |
Return a pointer to a new Field created on freestore. More... | |
static tmp< Field< scalar > > | NewCalculatedType (const Field< Type2 > &f) |
Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More... | |
Static Public Member Functions inherited from List< scalar > | |
static const List< scalar > & | null () |
Return a null List. More... | |
Static Public Member Functions inherited from UList< T > | |
static const UList< T > & | null () |
Return a UList reference to a nullObject. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Static Public Attributes inherited from fvPatchFieldBase | |
static int | disallowGenericPatchField |
Debug switch to disallow the use of generic fvPatchField. More... | |
Static Public Attributes inherited from FieldBase | |
static const char *const | typeName |
Typename for Field. More... | |
static bool | allowConstructFromLargerSize = false |
Permit read construct from a larger size. More... | |
Static Protected Attributes inherited from epsilonWallFunctionFvPatchScalarField | |
static scalar | tolerance_ = 1e-5 |
Tolerance used in weighted calculations. More... | |
This boundary condition provides a wall constraint on the turbulent kinetic energy dissipation rate (i.e. epsilon
) and the turbulent kinetic energy production contribution (i.e. G
) for atmospheric boundary layer modelling.
Theoretical expressions (tags:PGVB, RH): Parente, A., Gorlé, C., Van Beeck, J., & Benocci, C. (2011). Improved k–ε model and wall function formulation for the RANS simulation of ABL flows. J. of wind engineering and industrial aerodynamics, 99(4), 267-278. DOI:10.1016/j.jweia.2010.12.017 Richards, P. J., & Hoxey, R. P. (1993). Appropriate boundary conditions for computational wind engineering models using the k-ε turbulence model. In Computational Wind Engineering 1 (pp. 145-153). DOI:10.1016/B978-0-444-81688-7.50018-8
Required fields:
epsilon | Turbulent kinetic energy dissipation rate [m2/s3]
<patchName> { // Mandatory entries type atmEpsilonWallFunction; z0 <PatchFunction1<scalar>>; // Inherited entries ... }
where the entries mean:
Property | Description | Type | Reqd | Deflt |
---|---|---|---|---|
type | Type name: atmEpsilonWallFunction | word | yes | - |
z0 | Surface roughness length [m] | PatchFunction1<scalar> | yes | - |
The inherited entries are elaborated in:
Definition at line 118 of file atmEpsilonWallFunctionFvPatchScalarField.H.
atmEpsilonWallFunctionFvPatchScalarField | ( | const fvPatch & | p, |
const DimensionedField< scalar, volMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 132 of file atmEpsilonWallFunctionFvPatchScalarField.C.
Referenced by atmEpsilonWallFunctionFvPatchScalarField::clone().
atmEpsilonWallFunctionFvPatchScalarField | ( | const fvPatch & | p, |
const DimensionedField< scalar, volMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 158 of file atmEpsilonWallFunctionFvPatchScalarField.C.
atmEpsilonWallFunctionFvPatchScalarField | ( | const atmEpsilonWallFunctionFvPatchScalarField & | ptf, |
const fvPatch & | p, | ||
const DimensionedField< scalar, volMesh > & | iF, | ||
const fvPatchFieldMapper & | mapper | ||
) |
Construct by mapping given atmEpsilonWallFunctionFvPatchScalarField onto a new patch.
Definition at line 144 of file atmEpsilonWallFunctionFvPatchScalarField.C.
Construct as copy.
Definition at line 171 of file atmEpsilonWallFunctionFvPatchScalarField.C.
atmEpsilonWallFunctionFvPatchScalarField | ( | const atmEpsilonWallFunctionFvPatchScalarField & | ewfpsf, |
const DimensionedField< scalar, volMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 182 of file atmEpsilonWallFunctionFvPatchScalarField.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Calculate the epsilon and G.
Reimplemented from epsilonWallFunctionFvPatchScalarField.
Definition at line 31 of file atmEpsilonWallFunctionFvPatchScalarField.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::constant::electromagnetic::epsilon0, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::electromagnetic::G0, k, turbulenceModel::k(), Foam::constant::electromagnetic::kappa, Foam::mag(), turbulenceModel::nu(), turbulenceModel::nut(), Foam::foamVersion::patch, Foam::pow(), Foam::pow025(), fvPatchField< Type >::snGrad(), Foam::sqr(), Foam::sqrt(), turbulenceModel::U(), y, turbulenceModel::y(), and yPlus.
|
protected |
Write local wall function variables.
Definition at line 113 of file atmEpsilonWallFunctionFvPatchScalarField.C.
References os().
TypeName | ( | "atmEpsilonWallFunction" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Reimplemented from epsilonWallFunctionFvPatchScalarField.
Definition at line 205 of file atmEpsilonWallFunctionFvPatchScalarField.H.
References atmEpsilonWallFunctionFvPatchScalarField::atmEpsilonWallFunctionFvPatchScalarField().
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Reimplemented from epsilonWallFunctionFvPatchScalarField.
Definition at line 226 of file atmEpsilonWallFunctionFvPatchScalarField.H.
References atmEpsilonWallFunctionFvPatchScalarField::atmEpsilonWallFunctionFvPatchScalarField().
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented from fvPatchField< scalar >.
Definition at line 195 of file atmEpsilonWallFunctionFvPatchScalarField.C.
|
virtual |
Reverse map the given fvPatchField onto this fvPatchField.
Reimplemented from fvPatchField< scalar >.
Definition at line 209 of file atmEpsilonWallFunctionFvPatchScalarField.C.
|
virtual |
Write.
Reimplemented from epsilonWallFunctionFvPatchScalarField.
Definition at line 226 of file atmEpsilonWallFunctionFvPatchScalarField.C.
References os(), and Foam::vtk::write().
|
protected |
Surface roughness length field [m].
Definition at line 129 of file atmEpsilonWallFunctionFvPatchScalarField.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.