Functionality for sampling fields using mappedPatchBase. Every call to mappedField() returns a sampled field, optionally scaled to maintain an area-weighted average. More...
Public Member Functions | |
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... | |
virtual void | write (Ostream &os) const |
Write. 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 |
Static Public Member Functions | |
static const mappedPatchBase & | mapper (const fvPatch &p, const DimensionedField< Type, volMesh > &iF) |
Check that patch is of correct type. More... | |
Protected Member Functions | |
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... | |
Protected Attributes | |
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... | |
Functionality for sampling fields using mappedPatchBase. Every call to mappedField() returns a sampled field, optionally scaled to maintain an area-weighted average.
{ field T; // default is same as fvPatchField setAverage false; average 1.0; // only if setAverage=true interpolationScheme cellPoint; // default is cell }
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 apply if setAverage = yes | partly | ||
interpolationScheme | interpolation scheme | partly | cell |
Definition at line 101 of file mappedPatchFieldBase.H.
mappedPatchFieldBase | ( | const mappedPatchBase & | mapper, |
const fvPatchField< Type > & | patchField, | ||
const word & | fieldName, | ||
const bool | setAverage, | ||
const Type | average, | ||
const word & | interpolationScheme | ||
) |
Construct from components.
Definition at line 314 of file mappedPatchFieldBase.C.
mappedPatchFieldBase | ( | const mappedPatchBase & | mapper, |
const fvPatchField< Type > & | patchField, | ||
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 334 of file mappedPatchFieldBase.C.
mappedPatchFieldBase | ( | const mappedPatchBase & | mapper, |
const fvPatchField< Type > & | patchField, | ||
const dictionary & | dict, | ||
const Field< Type > & | fld | ||
) |
Construct from dictionary and initial field value.
(for when running in database mode)
Definition at line 390 of file mappedPatchFieldBase.C.
mappedPatchFieldBase | ( | const mappedPatchBase & | mapper, |
const fvPatchField< Type > & | patchField | ||
) |
Construct empty.
Definition at line 428 of file mappedPatchFieldBase.C.
|
explicit |
Construct copy.
Definition at line 444 of file mappedPatchFieldBase.C.
mappedPatchFieldBase | ( | const mappedPatchBase & | mapper, |
const fvPatchField< Type > & | patchField, | ||
const mappedPatchFieldBase< Type > & | base | ||
) |
Construct copy, resetting patch and field.
Definition at line 459 of file mappedPatchFieldBase.C.
|
virtualdefault |
Destructor.
|
protected |
Construct field from registered elements.
Definition at line 194 of file mappedPatchFieldBase.C.
|
protected |
Helper : storeField and retrieveField and interpolate. Leaves fld.
unchanged (and returns false) if new values cannot be retrieved. Returns true otherwise.
Definition at line 245 of file mappedPatchFieldBase.C.
Initialise field to retrieve (e.g. when value read from dictionary)
Definition at line 962 of file mappedPatchFieldBase.C.
|
protected |
Store elements of field onto (sub) registry.
Definition at line 47 of file mappedPatchFieldBase.C.
|
protected |
Construct field from registered elements.
Definition at line 98 of file mappedPatchFieldBase.C.
const GeometricField<T, fvPatchField, volMesh>& sampleField | ( | const word & | fieldName | ) | const |
Field to sample. Either on my or nbr mesh.
const Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > & sampleField | ( | ) | const |
Field to sample. Either on my or nbr mesh.
Definition at line 508 of file mappedPatchFieldBase.C.
|
virtual |
Map sampleField onto *this patch.
Definition at line 607 of file mappedPatchFieldBase.C.
|
virtual |
Map internal of sampleField onto *this patch.
Definition at line 814 of file mappedPatchFieldBase.C.
|
virtual |
Map optional weightField onto *this patch. Default is deltaCoeffs.
Definition at line 848 of file mappedPatchFieldBase.C.
|
virtual |
Map optional weightField (given by name) onto *this patch.
Definition at line 884 of file mappedPatchFieldBase.C.
|
virtual |
Write.
Reimplemented in turbulentTemperatureRadCoupledMixedFvPatchScalarField, thermalBaffleFvPatchScalarField, turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, mappedFieldFvPatchField< Type >, mappedMixedFieldFvPatchField< Type >, mappedMixedFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, and mappedFixedInternalValueFvPatchField< Type >.
Definition at line 988 of file mappedPatchFieldBase.C.
Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::write(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::write().
|
static |
Check that patch is of correct type.
Definition at line 940 of file mappedPatchFieldBase.C.
Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs().
Wrapper for mapDistribute::distribute that knows about dabase mapping.
Definition at line 517 of file mappedPatchFieldBase.C.
const Foam::GeometricField<Type2, Foam::fvPatchField, Foam::volMesh>& sampleField | ( | const word & | fieldName | ) | const |
Definition at line 479 of file mappedPatchFieldBase.C.
|
protected |
Mapping engine.
Definition at line 118 of file mappedPatchFieldBase.H.
|
protected |
Underlying patch field.
Definition at line 123 of file mappedPatchFieldBase.H.
|
protected |
Name of field to sample.
Definition at line 128 of file mappedPatchFieldBase.H.
|
protected |
If true adjust the mapped field to maintain average value average_.
Definition at line 133 of file mappedPatchFieldBase.H.
|
protected |
Average value the mapped field is adjusted to maintain if setAverage_ is set true.
Definition at line 139 of file mappedPatchFieldBase.H.
|
protected |
Interpolation scheme to use for nearestcell mode.
Definition at line 144 of file mappedPatchFieldBase.H.