This boundary condition provides a self-contained version of the mapped
condition. It does not use information on the patch; instead it holds the data locally.
More...
Public Member Functions | |
TypeName ("mappedField") | |
Runtime type information. More... | |
mappedFieldFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
mappedFieldFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
mappedFieldFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const scalar distance, const word &fieldName, const bool setAverage, const Type average, const word &interpolationScheme) | |
Construct from patch, internal field and distance for normal type. More... | |
mappedFieldFvPatchField (const mappedFieldFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping given. More... | |
mappedFieldFvPatchField (const mappedFieldFvPatchField< Type > &) | |
Construct as copy. More... | |
mappedFieldFvPatchField (const mappedFieldFvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual tmp< fvPatchField< Type > > | clone () const |
Return a clone. More... | |
virtual tmp< fvPatchField< Type > > | clone (const DimensionedField< Type, volMesh > &iF) const |
Clone with an internal field reference. More... | |
virtual void | autoMap (const fvPatchFieldMapper &) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const fvPatchField< Type > &, const labelList &) |
Reverse map the given fvPatchField onto this fvPatchField. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
virtual void | write (Ostream &) const |
Write. More... | |
Public Member Functions inherited from fixedValueFvPatchField< Type > | |
TypeName ("fixedValue") | |
Runtime type information. More... | |
fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value) | |
Construct from patch, internal field and value. More... | |
fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, IOobjectOption::readOption requireValue=IOobjectOption::MUST_READ) | |
Construct from patch, internal field and dictionary. More... | |
fixedValueFvPatchField (const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict, const bool needValue) | |
Compatibility (prefer with readOption) More... | |
fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping the given fixedValue patch field onto a new patch. More... | |
fixedValueFvPatchField (const fixedValueFvPatchField< Type > &) | |
Construct as copy. More... | |
fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual bool | fixesValue () const |
True: this patch field fixes a value. More... | |
virtual bool | assignable () const |
False: this patch field is not altered by assignment. More... | |
virtual tmp< Field< Type > > | valueInternalCoeffs (const tmp< scalarField > &) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | valueBoundaryCoeffs (const tmp< scalarField > &) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientInternalCoeffs () const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientBoundaryCoeffs () const |
Return the matrix source coefficients corresponding to the. More... | |
virtual void | operator= (const UList< Type > &) |
virtual void | operator= (const fvPatchField< Type > &) |
virtual void | operator+= (const fvPatchField< Type > &) |
virtual void | operator-= (const fvPatchField< Type > &) |
virtual void | operator*= (const fvPatchField< scalar > &) |
virtual void | operator/= (const fvPatchField< scalar > &) |
virtual void | operator+= (const Field< Type > &) |
virtual void | operator-= (const Field< Type > &) |
virtual void | operator*= (const Field< scalar > &) |
virtual void | operator/= (const Field< scalar > &) |
virtual void | operator= (const Type &) |
virtual void | operator+= (const Type &) |
virtual void | operator-= (const Type &) |
virtual void | operator*= (const scalar) |
virtual void | operator/= (const scalar) |
Public Member Functions inherited from fvPatchField< Type > | |
declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF)) | |
declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType &>(ptf), p, iF, m)) | |
declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType) | |
Construct from patch, internal field and patch type. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value) | |
Construct from patch, internal field and value. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &pfld) | |
Construct from patch, internal field and patch field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, Field< Type > &&pfld) | |
Construct from patch, internal field and patch field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &dict, IOobjectOption::readOption requireValue=IOobjectOption::MUST_READ) | |
Construct from patch, internal field and dictionary. More... | |
fvPatchField (const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict, const bool needValue) | |
Construct, forwarding to readOption variant. More... | |
fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping the given fvPatchField onto a new patch. More... | |
fvPatchField (const fvPatchField< Type > &) | |
Construct as copy. More... | |
fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual | ~fvPatchField ()=default |
Destructor. More... | |
const DimensionedField< Type, volMesh > & | internalField () const noexcept |
Return const-reference to the dimensioned internal field. More... | |
const Field< Type > & | primitiveField () const noexcept |
Return const-reference to the internal field values. More... | |
virtual tmp< Field< Type > > | snGrad () const |
Return patch-normal gradient. More... | |
virtual tmp< Field< Type > > | snGrad (const scalarField &deltaCoeffs) const |
Return patch-normal gradient for coupled-patches. More... | |
virtual void | updateWeightedCoeffs (const scalarField &weights) |
Update the coefficients associated with the patch field. More... | |
virtual tmp< Field< Type > > | patchInternalField () const |
Return internal field next to patch. More... | |
virtual void | patchInternalField (Field< Type > &pfld) const |
Extract internal field next to patch. More... | |
virtual tmp< Field< Type > > | patchNeighbourField () const |
Return patchField on the opposite patch of a coupled patch. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered) |
Initialise the evaluation of the patch field. More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered) |
Evaluate the patch field, sets updated() to false. More... | |
virtual void | initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered) |
Initialise the evaluation of the patch field after a local. More... | |
virtual void | evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered) |
Evaluate the patch field after a local operation (e.g. *=) More... | |
virtual tmp< Field< Type > > | valueInternalCoeffs (const tmp< Field< scalar >> &) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | valueBoundaryCoeffs (const tmp< Field< scalar >> &) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientInternalCoeffs (const scalarField &deltaCoeffs) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual void | manipulateMatrix (fvMatrix< Type > &matrix) |
Manipulate matrix. More... | |
virtual void | manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights) |
Manipulate matrix with given weights. More... | |
virtual void | manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp) |
Manipulate fvMatrix. More... | |
void | check (const fvPatchField< Type > &) const |
Check against given patch field. More... | |
virtual void | operator== (const fvPatchField< Type > &) |
virtual void | operator== (const Field< Type > &) |
virtual void | operator== (const Type &) |
bool | operator!= (const fvPatchField< Type > &) const =delete |
bool | operator!= (const Field< Type > &) const =delete |
bool | operator!= (const Type &) const =delete |
template<class AnyType > | |
Foam::tmp< Foam::fvPatchField< Type > > | NewCalculatedType (const fvPatchField< AnyType > &pf) |
Public Member Functions inherited from fvPatchFieldBase | |
void | setUpdated (bool state) noexcept |
Set updated state. More... | |
void | setManipulated (bool state) noexcept |
Set matrix manipulated state. More... | |
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... | |
virtual bool | coupled () const |
True if the patch field is coupled. 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< Type > | |
constexpr | Field () noexcept |
Default construct. More... | |
Field (const label len) | |
Construct given size. More... | |
Field (const label len, const Type &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 Type &val) | |
Construct with length=1, copying the value as the only content. More... | |
Field (const Foam::one, Type &&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< Type > &fld) | |
Copy construct. More... | |
Field (const UList< Type > &list) | |
Copy construct from UList<Type> More... | |
template<class Addr > | |
Field (const IndirectListBase< Type, Addr > &list) | |
Copy construct from IndirectList. More... | |
Field (Field< Type > &&fld) noexcept | |
Move construct from Field. More... | |
Field (List< Type > &&list) noexcept | |
Move construct from List. More... | |
template<int SizeMin> | |
Field (DynamicList< Type, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
Field (const UList< Type > &mapF, const labelUList &mapAddressing) | |
Construct by 1 to 1 mapping from the given field. More... | |
Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) | |
Construct by 1 to 1 mapping from the given tmp field. More... | |
Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given field. More... | |
Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given tmp field. More... | |
Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. More... | |
Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &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< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More... | |
Field (Field< Type > &fld, bool reuse) | |
Copy construct or re-use as specified. More... | |
Field (const tmp< Field< Type >> &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 &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) | |
Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): More... | |
tmp< Field< Type > > | clone () const |
Clone. More... | |
void | assign (const entry &e, const label len) |
Assign from a primitive dictionary entry with the following behaviour: More... | |
bool | assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) |
Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). More... | |
void | map (const UList< Type > &mapF, const labelUList &mapAddressing) |
1 to 1 map from the given field More... | |
void | map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
1 to 1 map from the given tmp field More... | |
void | map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given field. More... | |
void | map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given tmp field. More... | |
void | map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given field. More... | |
void | map (const tmp< Field< Type >> &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< Type > &mapF, const labelUList &mapAddressing) |
1 to 1 reverse-map from the given field More... | |
void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
1 to 1 reverse-map from the given tmp field More... | |
void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
Interpolative reverse map from the given field. More... | |
void | rmap (const tmp< Field< Type >> &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... | |
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... | |
void | clamp_min (const Type &lower) |
Impose lower (floor) clamp on the field values (in-place) More... | |
void | clamp_max (const Type &upper) |
Impose upper (ceiling) clamp on the field values (in-place) More... | |
void | clamp_range (const Type &lower, const Type &upper) |
Clamp field values (in-place) to the specified range. More... | |
void | clamp_range (const MinMax< Type > &range) |
Clamp field values (in-place) to the specified range. More... | |
template<class VSForm > | |
VSForm | block (const label start) const |
tmp< Field< Type > > | 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< Type > | slice (const label pos, label len=-1) |
Return SubField slice (non-const access) - no range checking. More... | |
const SubField< Type > | slice (const label pos, label len=-1) const |
Return SubField slice (const access) - no range checking. More... | |
SubField< Type > | slice (const labelRange &range) |
Return SubField slice (non-const access) - with range checking. More... | |
const SubField< Type > | slice (const labelRange &range) const |
Return SubField slice (const access) - with range checking. More... | |
void | operator= (const Field< Type > &) |
Copy assignment. More... | |
void | operator= (const tmp< Field< Type >> &) |
void | operator= (const UList< Type > &rhs) |
void | operator= (const SubField< Type > &rhs) |
template<class Addr > | |
void | operator= (const IndirectListBase< Type, Addr > &rhs) |
Copy assign from IndirectList. More... | |
void | operator= (Field< Type > &&rhs) |
Move assignment. More... | |
void | operator= (List< Type > &&rhs) |
template<int SizeMin> | |
void | operator= (DynamicList< Type, SizeMin > &&rhs) |
void | operator= (const Type &val) |
Assign entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assign entries to zero. More... | |
template<class Form , class Cmpt , direction nCmpt> | |
void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
void | operator+= (const UList< Type > &) |
void | operator+= (const tmp< Field< Type >> &) |
void | operator-= (const UList< Type > &) |
void | operator-= (const tmp< Field< Type >> &) |
void | operator*= (const UList< scalar > &) |
void | operator*= (const tmp< Field< scalar >> &) |
void | operator/= (const UList< scalar > &) |
void | operator/= (const tmp< Field< scalar >> &) |
void | operator+= (const Type &) |
void | operator-= (const Type &) |
void | operator*= (const scalar &) |
void | operator/= (const scalar &) |
template<class Type> | |
void | operator= (const tmp< Field > &rhs) |
template<> | |
void | normalise () |
template<> | |
void | normalise () |
template<> | |
void | normalise () |
Inplace normalise (float) vector field. More... | |
template<> | |
void | normalise () |
Inplace normalise (double) vector field. More... | |
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 | use_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< Type > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const Type &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 Type &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, Type &&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< Type > &list) | |
Copy construct from list. More... | |
List (const UList< Type > &list) | |
Copy construct contents from list. More... | |
List (List< Type > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< Type > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< Type > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< Type, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< Type > &list) | |
Construct as copy of PtrList<T> More... | |
List (const IndirectListBase< Type, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< Type > list) | |
Construct from an initializer list. More... | |
List (List< Type > &&list) noexcept | |
Move construct from List. More... | |
List (DynamicList< Type, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
List (const SLList< Type > &list) | |
Copy construct from SLList. More... | |
autoPtr< List< Type > > | 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 Type &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_fill (const label len, const Type &val) |
Adjust allocated size of list and set val for all elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | resize_unsafe (const label len) noexcept |
Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const Type &val) |
Alias for resize() More... | |
void | transfer (List< Type > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< Type, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
Type & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
Type & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const Type &val) |
Append an element at the end of the list. More... | |
void | push_back (Type &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< Type > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< Type, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const Type &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< Type > &list) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< Type > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< Type, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< Type, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< Type > list) |
Assignment to an initializer list. More... | |
void | operator= (const Type &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< Type > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< Type, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (const SLList< Type > &list) |
Copy assign from SLList in linear time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< Type > &)=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 Type &val) |
Append an element at the end of the list. More... | |
void | append (Type &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< Type > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< Type, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const Type &val) |
Same as push_uniq() More... | |
Public Member Functions inherited from UList< Type > | |
label | size () const noexcept |
The number of elements in the container. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
void | operator= (const Type &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
UList (const UList< Type > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (Type *__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 Type & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
Type & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const Type & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
Type & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const Type * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
Type * | 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... | |
Type & | front () |
Access first element of the list, position [0]. More... | |
const Type & | front () const |
Access first element of the list. More... | |
Type & | back () |
Access last element of the list, position [size()-1]. More... | |
const Type & | 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... | |
bool | contains (const Type &val) const |
True if the value is contained in the list. More... | |
bool | contains (const Type &val, label pos, label len=-1) const |
Is the value contained in the list? More... | |
label | find (const Type &val) const |
Find index of the first occurrence of the value. More... | |
label | find (const Type &val, label pos, label len=-1) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const Type &val, label pos=-1) const |
Find index of the last occurrence of the value. 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 (Type *__restrict__ ptr, const label len) noexcept |
Copy the pointer and size. More... | |
void | shallowCopy (std::nullptr_t) noexcept |
Copy nullptr and zero size. More... | |
void | shallowCopy (const UList< Type > &list) noexcept |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< Type > &list) |
Copy elements of the given UList. Sizes must match! More... | |
void | deepCopy (const IndirectListBase< Type, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< Type > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< Type > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< Type > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< Type > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
Type & | operator[] (const label i) |
Return element of UList. More... | |
const Type & | operator[] (const label i) const |
Return element of constant UList. More... | |
const bool & | operator[] (const label i) const |
UPstream::commsStruct & | operator[] (const label procID) |
const UPstream::commsStruct & | operator[] (const label procID) const |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
operator const Foam::List< Type > & () const | |
Allow cast to a const List<T>&. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | cend () 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... | |
const_reverse_iterator | rbegin () const |
Return const_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 | rend () const |
Return const_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... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
void | swap (UList< Type > &list) noexcept |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< Type > &list) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< Type > &list) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< Type > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< Type > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< Type > &list) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< Type > &list) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
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... | |
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... | |
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... | |
Type & | first () |
Access first element of the list, position [0]. More... | |
const Type & | first () const |
Access first element of the list. More... | |
Type & | last () |
Access last element of the list, position [size()-1]. More... | |
const Type & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const Type &val, label pos=0) const |
Same as contains() More... | |
Public Member Functions inherited from mappedPatchBase | |
TypeName ("mappedPatchBase") | |
Runtime type information. More... | |
mappedPatchBase (const polyPatch &) | |
Construct from patch. More... | |
mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vectorField &offsets) | |
Construct with offsetMode=non-uniform. More... | |
mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vector &uniformOffset) | |
Construct from offsetMode=uniform. More... | |
mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const scalar normalDistance) | |
Construct from offsetMode=normal and distance. More... | |
mappedPatchBase (const polyPatch &, const dictionary &) | |
Construct from dictionary. More... | |
mappedPatchBase (const polyPatch &, const sampleMode, const dictionary &) | |
Construct from dictionary and (collocated) sample mode. More... | |
mappedPatchBase (const polyPatch &, const mappedPatchBase &) | |
Construct as copy, resetting patch. More... | |
mappedPatchBase (const polyPatch &, const mappedPatchBase &, const labelUList &mapAddressing) | |
Construct as copy, resetting patch, map original data. More... | |
virtual | ~mappedPatchBase () |
Destructor. More... | |
void | clearOut () |
void | setOffset (const scalar normalDist) |
Change to normal offset with given distance. More... | |
void | setOffset (const vector &uniformOffset) |
Change to uniform offset with value. More... | |
void | setOffset (const vectorField &offsets) |
Change to non-uniform offsets. More... | |
sampleMode | mode () const noexcept |
What to sample. More... | |
const word & | sampleWorld () const noexcept |
World to sample. More... | |
const word & | sampleRegion () const |
Region to sample. More... | |
const word & | samplePatch () const |
Patch (only if NEARESTPATCHFACE) More... | |
const word & | coupleGroup () const |
PatchGroup (only if NEARESTPATCHFACE) More... | |
label | sampleSize () const |
Return size of mapped mesh/patch/boundary. More... | |
const vector & | offset () const noexcept |
Offset vector (from patch faces to destination mesh objects) More... | |
const vectorField & | offsets () const noexcept |
Offset vectors (from patch faces to destination mesh objects) More... | |
label | getCommunicator () const |
Get the communicator (worldComm or world-to-world) More... | |
label | comm () const |
Identical to getCommunicator() More... | |
bool | sameWorld () const |
Is sample world the local world? More... | |
bool | masterWorld () const |
Is my world ordered before the sampleWorld? More... | |
bool | sameRegion () const noexcept |
Cached sampleRegion != mesh.name() More... | |
uniformDimensionedScalarField & | updateSampleMeshTime () const |
Local mesh update time. More... | |
uniformDimensionedScalarField & | updateMeshTime () const |
Sample mesh upate time. More... | |
bool | upToDate () const |
const mapDistribute & | map () const |
Return reference to the parallel distribution map. More... | |
const AMIPatchToPatchInterpolation & | AMI (const bool forceUpdate=false) const |
Return reference to the AMI interpolator. More... | |
bool | owner () const |
Is it owner. More... | |
const autoPtr< Foam::searchableSurface > & | surfPtr () const |
Return a pointer to the AMI projection surface. More... | |
const polyMesh & | sampleMesh () const |
Get the region mesh. More... | |
const polyPatch & | samplePolyPatch () const |
Get the patch on the region. More... | |
tmp< pointField > | samplePoints () const |
Get the sample points. More... | |
const fileName & | sampleDatabasePath () const |
bool | sampleDatabase () const |
virtual fileName | sendPath (const label proci) const |
virtual fileName | receivePath (const label proci) const |
template<class Type > | |
void | distribute (List< Type > &lst) const |
Wrapper around map/interpolate data distribution. More... | |
template<class Type , class CombineOp > | |
void | distribute (List< Type > &lst, const CombineOp &cop) const |
Wrapper around map/interpolate data distribution with operation. More... | |
template<class Type > | |
void | reverseDistribute (List< Type > &lst) const |
Wrapper around map/interpolate data distribution. More... | |
template<class Type , class CombineOp > | |
void | reverseDistribute (List< Type > &lst, const CombineOp &cop) const |
Wrapper around map/interpolate data distribution with operation. More... | |
Public Member Functions inherited from mappedPatchFieldBase< Type > | |
mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const word &fieldName, const bool setAverage, const Type average, const word &interpolationScheme) | |
Construct from components. More... | |
mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict) | |
Construct from dictionary. More... | |
mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict, const Field< Type > &fld) | |
Construct from dictionary and initial field value. More... | |
mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField) | |
Construct empty. More... | |
mappedPatchFieldBase (const mappedPatchFieldBase< Type > &mapper) | |
Construct copy. More... | |
mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const mappedPatchFieldBase< Type > &base) | |
Construct copy, resetting patch and field. More... | |
virtual | ~mappedPatchFieldBase ()=default |
Destructor. More... | |
template<class T > | |
const GeometricField< T, fvPatchField, volMesh > & | sampleField (const word &fieldName) const |
Field to sample. Either on my or nbr mesh. More... | |
const GeometricField< Type, fvPatchField, volMesh > & | sampleField () const |
Field to sample. Either on my or nbr mesh. More... | |
virtual tmp< Field< Type > > | mappedField () const |
Map sampleField onto *this patch. More... | |
virtual tmp< Field< Type > > | mappedInternalField () const |
Map internal of sampleField onto *this patch. More... | |
virtual tmp< scalarField > | mappedWeightField () const |
Map optional weightField onto *this patch. Default is deltaCoeffs. More... | |
virtual void | mappedWeightField (const word &weightFieldName, tmp< scalarField > &thisWeights, tmp< scalarField > &nbrWeights) const |
Map optional weightField (given by name) onto *this patch. More... | |
template<class T > | |
void | distribute (const word &fieldName, Field< T > &newValues) const |
Wrapper for mapDistribute::distribute that knows about dabase mapping. More... | |
template<class Type2 > | |
const Foam::GeometricField< Type2, Foam::fvPatchField, Foam::volMesh > & | sampleField (const word &fieldName) const |
Additional Inherited Members | |
Public Types inherited from fvPatchField< Type > | |
typedef fvPatch | Patch |
The patch type for the patch field. More... | |
typedef Type | value_type |
The value_type for the patch field. More... | |
typedef DimensionedField< Type, volMesh > | Internal |
The internal field type associated with the patch field. More... | |
typedef calculatedFvPatchField< Type > | Calculated |
Type for a calculated patch. More... | |
Public Types inherited from Field< Type > | |
typedef pTraits< Type >::cmptType | cmptType |
Component type. More... | |
typedef SubField< Type > | subField |
Declare type of subField. More... | |
Public Types inherited from List< Type > | |
typedef SubList< Type > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< Type > | |
typedef Type | value_type |
The value type the list contains. More... | |
typedef Type * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const Type * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef Type & | reference |
The type used for storing into value_type objects. More... | |
typedef const Type & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef Type * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const Type * | 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... | |
Public Types inherited from mappedPatchBase | |
enum | sampleMode { NEARESTCELL, NEARESTPATCHFACE, NEARESTPATCHFACEAMI, NEARESTPATCHPOINT, NEARESTFACE, NEARESTONLYCELL } |
Mesh items to sample. More... | |
enum | offsetMode { UNIFORM, NONUNIFORM, NORMAL } |
How to project face centres. More... | |
typedef Tuple2< pointIndexHit, Tuple2< scalar, label > > | nearInfo |
Helper class for finding nearest. More... | |
typedef Tuple2< nearInfo, label > | nearInfoWorld |
nearest + world More... | |
Static Public Member Functions inherited from fvPatchField< Type > | |
template<class DerivedPatchField , class... Args> | |
static tmp< fvPatchField< Type > > | Clone (const DerivedPatchField &pf, Args &&... args) |
Clone a patch field, optionally with internal field reference etc. More... | |
static tmp< fvPatchField< Type > > | New (const word &patchFieldType, const fvPatch &, const DimensionedField< Type, volMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
static tmp< fvPatchField< Type > > | New (const word &patchFieldType, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
static tmp< fvPatchField< Type > > | New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) |
Return a pointer to a new patchField created on freestore from. More... | |
static tmp< fvPatchField< Type > > | New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) |
Return a pointer to a new patchField created on freestore. More... | |
static tmp< fvPatchField< Type > > | NewCalculatedType (const fvPatch &p) |
Return a pointer to a new calculatedFvPatchField created on. More... | |
template<class AnyType > | |
static tmp< fvPatchField< Type > > | NewCalculatedType (const fvPatchField< AnyType > &pf) |
Return a pointer to a new calculatedFvPatchField created on. More... | |
Static Public Member Functions inherited from fvPatchFieldBase | |
static const word & | emptyType () noexcept |
The type name for empty patch fields. More... | |
static const word & | calculatedType () noexcept |
The type name for calculated patch fields. More... | |
static const word & | extrapolatedCalculatedType () noexcept |
The type name for extrapolatedCalculated patch fields combines zero-gradient and calculated . More... | |
static const word & | zeroGradientType () noexcept |
The type name for zeroGradient patch fields. More... | |
Static Public Member Functions inherited from Field< Type > | |
static const Field< Type > & | null () noexcept |
Return a null Field (reference to a nullObject). Behaves like an empty Field. More... | |
static autoPtr< Field< Type > > | New (Istream &is) |
Return a pointer to a new Field created on freestore. More... | |
template<class Type2 > | |
static tmp< Field< Type > > | 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< Type > | |
static const List< Type > & | null () noexcept |
Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
Static Public Member Functions inherited from UList< Type > | |
static const UList< Type > & | null () noexcept |
Return a null UList (reference to a nullObject). Behaves like an empty UList. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Static Public Member Functions inherited from mappedPatchBase | |
static pointIndexHit | facePoint (const polyMesh &, const label facei, const polyMesh::cellDecomposition) |
Get a point on the face given a face decomposition method: More... | |
static fileName | sendPath (const fileName &root, const label proci) |
Helper: return path to store data to be sent to processor i. More... | |
static fileName | receivePath (const fileName &root, const label proci) |
Helper: return path to store data to be received from processor i. More... | |
static const objectRegistry & | subRegistry (const objectRegistry &obr, const fileName &path) |
Lookup (sub)objectRegistry from '/' separated path (relative to objectRegistry). Creates non-existing intermediate ones. More... | |
template<class Type > | |
static void | storeField (objectRegistry &obr, const word &fieldName, const Field< Type > &values) |
Store an IOField on the objectRegistry relative to obr. More... | |
static void | writeDict (const objectRegistry &obr, dictionary &dict) |
Convert objectRegistry contents into dictionary. More... | |
static void | readDict (const dictionary &d, objectRegistry &obr) |
(recursively) construct and register IOFields from dictionary More... | |
Static Public Member Functions inherited from mappedPatchFieldBase< Type > | |
static const mappedPatchBase & | mapper (const fvPatch &p, const DimensionedField< Type, volMesh > &iF) |
Check that patch is of correct type. 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 Public Attributes inherited from mappedPatchBase | |
static const Enum< sampleMode > | sampleModeNames_ |
static const Enum< offsetMode > | offsetModeNames_ |
Protected Member Functions inherited from fvPatchField< Type > | |
bool | readValueEntry (const dictionary &dict, IOobjectOption::readOption readOpt=IOobjectOption::LAZY_READ) |
Read the "value" entry into *this . More... | |
void | writeValueEntry (Ostream &os) const |
Write *this field as a "value" entry. More... | |
void | extrapolateInternal () |
Assign the patch field from the internal field. More... | |
Protected Member Functions inherited from fvPatchFieldBase | |
virtual void | readDict (const dictionary &dict) |
Read dictionary entries. More... | |
Protected Member Functions inherited from UList< Type > | |
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... | |
void | writeEntry (Ostream &os) const |
Character list writeEntry. More... | |
void | writeEntry (Ostream &os) const |
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... | |
void | fill_uniform (const Type &val) |
Assign all entries to the given value. More... | |
void | fill_uniform (const Foam::zero) |
Assign all entries to zero. More... | |
UList< Type > & | operator= (const UList< Type > &)=delete |
No copy assignment (default: shallow copy) More... | |
void | operator= (const Foam::zero) |
Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
void | operator= (const Foam::zero) |
Protected Member Functions inherited from mappedPatchBase | |
virtual void | initGeometry (PstreamBuffers &) |
Initialise the calculation of the patch geometry. More... | |
virtual void | calcGeometry (PstreamBuffers &) |
Calculate the patch geometry. More... | |
virtual void | initMovePoints (PstreamBuffers &, const pointField &) |
Initialise the patches for moving points. More... | |
virtual void | movePoints (PstreamBuffers &, const pointField &) |
Correct patches after moving points. More... | |
virtual void | initUpdateMesh (PstreamBuffers &) |
Initialise the update of the patch topology. More... | |
virtual void | updateMesh (PstreamBuffers &) |
Update of the patch topology. More... | |
bool | addWorldConnection () |
Add a world-world connection. More... | |
label | getWorldCommunicator () const |
Get the communicator for the world-world connection. More... | |
const polyMesh & | lookupMesh (const word ®ion) const |
Lookup mesh. More... | |
const polyPatch & | lookupPatch (const word &sampleRegion, const word &samplePatch) const |
Lookup patch. More... | |
tmp< pointField > | facePoints (const polyPatch &) const |
Get the points from face-centre-decomposition face centres and project them onto the face-diagonal-decomposition triangles. More... | |
void | collectSamples (const label mySampleWorld, const pointField &facePoints, pointField &samples, labelList &patchFaceWorlds, labelList &patchFaceProcs, labelList &patchFaces, pointField &patchFc) const |
Collect single list of samples and originating processor+face + wanted world. More... | |
void | findLocalSamples (const sampleMode mode, const label sampleWorld, const word &sampleRegion, const word &samplePatch, const pointField &samplePoints, List< nearInfoWorld > &nearest) const |
Find (local) cells/faces containing samples. More... | |
void | findSamples (const sampleMode mode, const label myWorldIndex, const pointField &, const labelList &wantedWorlds, const labelList &origProcs, labelList &sampleProcs, labelList &sampleIndices, pointField &sampleLocations) const |
Find (global) cells/faces containing samples. More... | |
tmp< pointField > | samplePoints (const pointField &) const |
Get the sample points given the face points. More... | |
void | calcMapping () const |
Calculate mapping. More... | |
void | calcAMI () const |
Calculate AMI interpolator. More... | |
Protected Member Functions inherited from mappedPatchFieldBase< Type > | |
template<class T > | |
void | initRetrieveField (const objectRegistry &obr, const word ®ion, const word &patch, const labelListList &map, const word &fieldName, const Field< T > &fld) const |
Construct field from registered elements. More... | |
template<class T > | |
bool | storeAndRetrieveField (const word &fieldName, const label myComm, const labelListList &subMap, const label constructSize, const labelListList &constructMap, const labelListList &address, const scalarListList &weights, Field< T > &fld) const |
Helper : storeField and retrieveField and interpolate. Leaves fld. More... | |
template<class T > | |
void | initRetrieveField (const word &fieldName, const Field< T > &fld) const |
Initialise field to retrieve (e.g. when value read from dictionary) More... | |
template<class T > | |
void | storeField (const objectRegistry &obr, const word ®ion, const word &patch, const label myComm, const labelListList &procToMap, const word &fieldName, const Field< T > &fld) const |
Store elements of field onto (sub) registry. More... | |
template<class T > | |
bool | retrieveField (const bool allowUnset, const objectRegistry &obr, const word ®ion, const word &patch, const label myComm, const labelListList &procToMap, const word &fieldName, Field< T > &fld) const |
Construct field from registered elements. More... | |
Static Protected Member Functions inherited from mappedPatchBase | |
static autoPtr< fileName > | readDatabase (const dictionary &dict) |
Read optional database name from dictionary. More... | |
static const objectRegistry & | subRegistry (const objectRegistry &obr, const wordList &names, const label index) |
Lookup (sub)objectRegistry by following names of sub registries. Creates non-existing intermediate ones. More... | |
template<class Type > | |
static bool | writeIOField (const regIOobject &obj, dictionary &dict) |
Attempt to detect an IOField<Type> and write to dictionary. More... | |
template<class Type > | |
static bool | constructIOField (const word &name, token &tok, Istream &is, objectRegistry &obr) |
Attempt to read an IOField<Type> and store on objectRegistry. More... | |
Protected Attributes inherited from mappedPatchBase | |
const polyPatch & | patch_ |
Patch to sample. More... | |
word | sampleWorld_ |
World to sample. More... | |
word | sampleRegion_ |
Region to sample. More... | |
const sampleMode | mode_ |
What to sample. More... | |
word | samplePatch_ |
Patch (if in sampleMode NEARESTPATCH*) More... | |
const coupleGroupIdentifier | coupleGroup_ |
PatchGroup (if in sampleMode NEARESTPATCH*) More... | |
const autoPtr< fileName > | sampleDatabasePtr_ |
Empty or location of database. More... | |
offsetMode | offsetMode_ |
How to obtain samples. More... | |
vector | offset_ |
Offset vector (uniform) More... | |
vectorField | offsets_ |
Offset vector (nonuniform) More... | |
scalar | distance_ |
Offset distance (normal) More... | |
label | communicator_ |
Communicator. More... | |
bool | sameRegion_ |
Same region. More... | |
autoPtr< mapDistribute > | mapPtr_ |
Communication schedule: More... | |
const bool | AMIReverse_ |
Flag to indicate that slave patch should be reversed for AMI. More... | |
autoPtr< AMIPatchToPatchInterpolation > | AMIPtr_ |
Pointer to AMI interpolator. More... | |
autoPtr< searchableSurface > | surfPtr_ |
Pointer to projection surface employed by AMI interpolator. More... | |
dictionary | surfDict_ |
Dictionary storing projection surface description. More... | |
autoPtr< uniformDimensionedScalarField > | updateMeshTimePtr_ |
Local mesh update time. More... | |
autoPtr< uniformDimensionedScalarField > | updateSampleMeshTimePtr_ |
Sample mesh update time. More... | |
Protected Attributes inherited from mappedPatchFieldBase< Type > | |
const mappedPatchBase & | mapper_ |
Mapping engine. More... | |
const fvPatchField< Type > & | patchField_ |
Underlying patch field. More... | |
word | fieldName_ |
Name of field to sample. More... | |
const bool | setAverage_ |
If true adjust the mapped field to maintain average value average_. More... | |
const Type | average_ |
Average value the mapped field is adjusted to maintain if setAverage_ is set true. More... | |
word | interpolationScheme_ |
Interpolation scheme to use for nearestcell mode. More... | |
This boundary condition provides a self-contained version of the mapped
condition. It does not use information on the patch; instead it holds the data locally.
Property | Description | Required | Default | |
---|---|---|---|---|
field | Name of field to be mapped | no | this field name | |
setAverage | Use average value | no | false | |
average | Average value to use if setAverage = yes | partly |
Example of the boundary condition specification:
<patchName> { type mappedField; field T; // optional field name setAverage no; // apply an average value average 0; // average to apply if setAverage value uniform 0; // place holder }
mapped
condition in preference to avoid this situation, and only employ this condition if it is not possible to change the underlying geometric (poly) patch type to mapped
.Definition at line 110 of file mappedFieldFvPatchField.H.
mappedFieldFvPatchField | ( | const fvPatch & | p, |
const DimensionedField< Type, volMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 29 of file mappedFieldFvPatchField.C.
mappedFieldFvPatchField | ( | const fvPatch & | p, |
const DimensionedField< Type, volMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 42 of file mappedFieldFvPatchField.C.
mappedFieldFvPatchField | ( | const fvPatch & | p, |
const DimensionedField< Type, volMesh > & | iF, | ||
const word & | sampleRegion, | ||
const sampleMode | sampleMode, | ||
const word & | samplePatch, | ||
const scalar | distance, | ||
const word & | fieldName, | ||
const bool | setAverage, | ||
const Type | average, | ||
const word & | interpolationScheme | ||
) |
Construct from patch, internal field and distance for normal type.
sampling
Definition at line 71 of file mappedFieldFvPatchField.C.
mappedFieldFvPatchField | ( | const mappedFieldFvPatchField< Type > & | ptf, |
const fvPatch & | p, | ||
const DimensionedField< Type, volMesh > & | iF, | ||
const fvPatchFieldMapper & | mapper | ||
) |
Construct by mapping given.
mappedFieldFvPatchField onto a new patch
Definition at line 56 of file mappedFieldFvPatchField.C.
mappedFieldFvPatchField | ( | const mappedFieldFvPatchField< Type > & | ptf | ) |
Construct as copy.
Definition at line 111 of file mappedFieldFvPatchField.C.
mappedFieldFvPatchField | ( | const mappedFieldFvPatchField< Type > & | ptf, |
const DimensionedField< Type, volMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 123 of file mappedFieldFvPatchField.C.
TypeName | ( | "mappedField" | ) |
Runtime type information.
|
inlinevirtual |
Return a clone.
Reimplemented from fixedValueFvPatchField< Type >.
Definition at line 203 of file mappedFieldFvPatchField.H.
References fvPatchField< Type >::Clone().
|
inlinevirtual |
Clone with an internal field reference.
Reimplemented from fixedValueFvPatchField< Type >.
Definition at line 212 of file mappedFieldFvPatchField.H.
References fvPatchField< Type >::Clone().
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented from fvPatchField< Type >.
Definition at line 138 of file mappedFieldFvPatchField.C.
|
virtual |
Reverse map the given fvPatchField onto this fvPatchField.
Reimplemented from fvPatchField< Type >.
Definition at line 149 of file mappedFieldFvPatchField.C.
|
virtual |
Update the coefficients associated with the patch field.
Reimplemented from fvPatchField< Type >.
Definition at line 160 of file mappedFieldFvPatchField.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::Info, Foam::operator==(), and Foam::foamVersion::patch.
|
virtual |
Write.
Reimplemented from fixedValueFvPatchField< Type >.
Definition at line 184 of file mappedFieldFvPatchField.C.
References os(), and Foam::vtk::write().