Patch value mapping from file. More...
Public Member Functions | |
TypeName ("mappedFile") | |
Runtime type information. More... | |
MappedFile (const polyPatch &pp, const word &type, const word &entryName, const dictionary &dict, const bool faceValues=true) | |
Construct from entry name and dictionary. More... | |
MappedFile (const polyPatch &pp, const word &entryName, const dictionary &dict, const word &fieldTableName, const bool faceValues) | |
Construct from entry name and dictionary. More... | |
MappedFile (const MappedFile< Type > &ut) | |
Copy constructor. More... | |
MappedFile (const MappedFile< Type > &ut, const polyPatch &pp) | |
Copy constructor setting patch. More... | |
virtual tmp< PatchFunction1< Type > > | clone () const |
Construct and return a clone. More... | |
virtual tmp< PatchFunction1< Type > > | clone (const polyPatch &pp) const |
Construct and return a clone setting patch. More... | |
virtual | ~MappedFile ()=default |
Destructor. More... | |
virtual tmp< Field< Type > > | value (const scalar) const |
Return MappedFile value. More... | |
virtual bool | constant () const |
Is value constant (i.e. independent of x) More... | |
virtual bool | uniform () const |
Is value uniform (i.e. independent of coordinate) More... | |
virtual tmp< Field< Type > > | integrate (const scalar x1, const scalar x2) const |
Integrate between two values. More... | |
virtual void | autoMap (const FieldMapper &mapper) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const PatchFunction1< Type > &pf1, const labelList &addr) |
Reverse map the given PatchFunction1 onto this PatchFunction1. More... | |
virtual void | writeData (Ostream &os) const |
Write in dictionary format. More... | |
Public Member Functions inherited from PatchFunction1< Type > | |
TypeName ("PatchFunction1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
PatchFunction1 (const polyPatch &pp, const word &entryName, const bool faceValues=true) | |
Construct from polyPatch and entry name. More... | |
PatchFunction1 (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true) | |
Construct from polyPatch, dictionary and entry name. More... | |
PatchFunction1 (const PatchFunction1< Type > &pf1) | |
Copy constructor. More... | |
PatchFunction1 (const PatchFunction1< Type > &pf1, const polyPatch &pp) | |
Copy constructor setting patch. More... | |
virtual | ~PatchFunction1 ()=default |
Destructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
const polyPatch & | patch () const |
Reference to the patch. More... | |
bool | faceValues () const |
Whether to generate face or point values on patch. More... | |
virtual void | convertTimeBase (const Time &t) |
Convert time. More... | |
virtual tmp< pointField > | localPosition (const pointField &globalPos) const |
Helper: optionally convert coordinates to local coordinates. More... | |
virtual tmp< Field< Type > > | transform (const Field< Type > &fld) const |
Apply optional transformation. More... | |
virtual tmp< Field< Type > > | transform (const tmp< Field< Type >> &tfld) const |
Apply optional transformation. More... | |
Additional Inherited Members | |
Public Types inherited from PatchFunction1< Type > | |
typedef Field< Type > | returnType |
Static Public Member Functions inherited from PatchFunction1< Type > | |
static autoPtr< PatchFunction1< Type > > | New (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true) |
Selector. More... | |
Public Attributes inherited from PatchFunction1< Type > | |
PatchFunction1 | |
dictionary | |
const polyPatch & | pp |
const polyPatch const word & | type |
const polyPatch const word const word & | entryName |
const polyPatch const word const word const dictionary & | dict |
const polyPatch const word const word const dictionary const bool | faceValues |
const polyPatch const word const word const dictionary const bool | pp |
const polyPatch const word const word const dictionary const bool | type |
const polyPatch const word const word const dictionary const bool | entryName |
const polyPatch const word const word const dictionary const bool | dict |
Protected Attributes inherited from PatchFunction1< Type > | |
const word | name_ |
Name of entry. More... | |
const polyPatch & | patch_ |
Reference to the patch. More... | |
const bool | faceValues_ |
Whether to generate face or point values on patch. More... | |
coordinateScaling< Type > | coordSys_ |
Optional local co-ordinate system and scaling. More... | |
Patch value mapping from file.
Property | Description | Required | Default |
---|---|---|---|
mapMethod | (nearest/planarInterpolation) | no | planarInterpolation |
offset | Time-varying offset values to interpolated data | no | |
fieldTable | Name of field data table | no | field-name |
points | The name of the points file | no | points |
perturb | Perturbation fraction of bounding box | no | 1e-5 |
setAverage | adjust mapped field to maintain average value | no | false |
Definition at line 101 of file MappedFile.H.
MappedFile | ( | const polyPatch & | pp, |
const word & | type, | ||
const word & | entryName, | ||
const dictionary & | dict, | ||
const bool | faceValues = true |
||
) |
Construct from entry name and dictionary.
Definition at line 35 of file MappedFile.C.
References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::New().
MappedFile | ( | const polyPatch & | pp, |
const word & | entryName, | ||
const dictionary & | dict, | ||
const word & | fieldTableName, | ||
const bool | faceValues | ||
) |
Construct from entry name and dictionary.
Definition at line 89 of file MappedFile.C.
References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::New().
|
explicit |
Copy constructor.
Definition at line 141 of file MappedFile.C.
|
explicit |
Copy constructor setting patch.
Definition at line 166 of file MappedFile.C.
|
virtualdefault |
Destructor.
TypeName | ( | "mappedFile" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Implements PatchFunction1< Type >.
Definition at line 200 of file MappedFile.H.
|
inlinevirtual |
Construct and return a clone setting patch.
Implements PatchFunction1< Type >.
Definition at line 209 of file MappedFile.H.
References PatchFunction1< Type >::pp.
|
virtual |
Return MappedFile value.
Reimplemented from PatchFunction1< Type >.
Definition at line 491 of file MappedFile.C.
References Foam::expressions::patchExpr::debug, stdFoam::end(), Foam::endl(), fld, Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::gSum(), Foam::mag(), OSstream::name(), fileName::name(), Foam::New(), Foam::nl, Foam::Pout, s, Foam::transform(), and x.
Is value constant (i.e. independent of x)
Implements PatchFunction1< Type >.
Definition at line 230 of file MappedFile.H.
Is value uniform (i.e. independent of coordinate)
Implements PatchFunction1< Type >.
Definition at line 236 of file MappedFile.H.
References PatchFunction1< Type >::uniform().
|
virtual |
Integrate between two values.
Reimplemented from PatchFunction1< Type >.
Definition at line 601 of file MappedFile.C.
References NotImplemented.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented from PatchFunction1< Type >.
Definition at line 194 of file MappedFile.C.
|
virtual |
Reverse map the given PatchFunction1 onto this PatchFunction1.
Reimplemented from PatchFunction1< Type >.
Definition at line 214 of file MappedFile.C.
References MappedFile< Type >::rmap().
Referenced by MappedFile< Type >::rmap().
|
virtual |
Write in dictionary format.
Reimplemented from PatchFunction1< Type >.
Definition at line 613 of file MappedFile.C.
References Foam::constant::electromagnetic::e, Foam::name(), writeData(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().