Base class for mapped patch fields. More...
Public Member Functions | |
TypeName ("mappedValue") | |
Runtime type information. More... | |
mappedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
mappedFvPatchField (const mappedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping given mappedFvPatchField. More... | |
mappedFvPatchField (const mappedFvPatchField< Type > &)=delete | |
Disallow copy without setting internal field reference. More... | |
mappedFvPatchField (const mappedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Copy constructor setting internal field reference. More... | |
virtual | ~mappedFvPatchField () |
Destructor. More... | |
virtual void | clearOut () |
Clear the mapper if present. More... | |
virtual void | write (Ostream &) const |
Write. More... | |
Protected Member Functions | |
const mappedPatchBase & | mapper () const |
Return the mapping engine. More... | |
const fvPatchField< Type > & | nbrPatchField () const |
Return the neighbouring patch field. More... | |
tmp< Field< Type > > | mappedValues (const Field< Type > &nbrPatchField) const |
Return the mapped values, given the neighbouring field. More... | |
Protected Attributes | |
const fvPatch & | p_ |
Reference to the patch. More... | |
const DimensionedField< Type, volMesh > & | iF_ |
Reference to the internal field. More... | |
const word | fieldName_ |
The field to map. More... | |
const bool | setAverage_ |
If true adjust the sampled field to maintain an average value. More... | |
const Type | average_ |
Average value the sampled field is adjusted to. More... | |
autoPtr< mappedPatchBase > | mapperPtr_ |
The mapping engine. More... | |
Base class for mapped patch fields.
Property | Description | Required | Default value |
---|---|---|---|
field | name of field to be mapped | no | this field name |
setAverage | set the average value? | no | yes if average is specified, no otherwise |
average | average value to apply | if setAverage is true |
This boundary condition will usually be applied to a patch which is of mappedPatchBase type, and which holds all the necessary mapping information. It can also create its own mapping data which overrides that in the mapped patch, or so that it can be applied to a non-mapped patch. This is triggered by the presence of controls relating to mappedPatchBase (i.e., neighbourRegion, neighbourPatch, etc ...).
Definition at line 91 of file mappedFvPatchField.H.
mappedFvPatchField | ( | const fvPatch & | p, |
const DimensionedField< Type, volMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 103 of file mappedFvPatchField.C.
mappedFvPatchField | ( | const mappedFvPatchField< Type > & | ptf, |
const fvPatch & | p, | ||
const DimensionedField< Type, volMesh > & | iF, | ||
const fvPatchFieldMapper & | mapper | ||
) |
Construct by mapping given mappedFvPatchField.
onto a new patch
Definition at line 153 of file mappedFvPatchField.C.
|
delete |
Disallow copy without setting internal field reference.
mappedFvPatchField | ( | const mappedFvPatchField< Type > & | ptf, |
const DimensionedField< Type, volMesh > & | iF | ||
) |
Copy constructor setting internal field reference.
Definition at line 176 of file mappedFvPatchField.C.
|
inlinevirtual |
Destructor.
Definition at line 169 of file mappedFvPatchField.H.
|
protected |
Return the mapping engine.
Definition at line 33 of file mappedFvPatchField.C.
|
protected |
Return the neighbouring patch field.
Definition at line 44 of file mappedFvPatchField.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and IOobject::name().
|
protected |
Return the mapped values, given the neighbouring field.
Definition at line 63 of file mappedFvPatchField.C.
References Foam::gSum(), Foam::mag(), and tmp< T >::ref().
TypeName | ( | "mappedValue" | ) |
Runtime type information.
|
virtual |
Clear the mapper if present.
Definition at line 199 of file mappedFvPatchField.C.
Referenced by mappedFilmPressureFvPatchScalarField::map(), mappedValueFvPatchField< Type >::map(), mappedFilmPressureFvPatchScalarField::reset(), and mappedValueFvPatchField< Type >::reset().
|
virtual |
Write.
Reimplemented in mappedValueAndPatchInternalValueFvPatchField< Type >, mappedValueFvPatchField< Type >, and mappedFilmPressureFvPatchScalarField.
Definition at line 209 of file mappedFvPatchField.C.
References IOstream::name(), Foam::writeEntry(), and Foam::writeEntryIfDifferent().
Referenced by mappedFilmPressureFvPatchScalarField::write(), and mappedValueFvPatchField< Type >::write().
|
protected |
Reference to the patch.
Definition at line 98 of file mappedFvPatchField.H.
|
protected |
Reference to the internal field.
Definition at line 101 of file mappedFvPatchField.H.
|
protected |
The field to map.
Definition at line 104 of file mappedFvPatchField.H.
|
protected |
If true adjust the sampled field to maintain an average value.
Definition at line 107 of file mappedFvPatchField.H.
|
protected |
Average value the sampled field is adjusted to.
Definition at line 110 of file mappedFvPatchField.H.
|
protected |
The mapping engine.
Definition at line 113 of file mappedFvPatchField.H.