Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits. More...
Public Types | |
typedef Field< Type > | returnType |
Public Member Functions | |
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 tmp< PatchFunction1< Type > > | clone () const =0 |
Construct and return a clone. More... | |
virtual tmp< PatchFunction1< Type > > | clone (const polyPatch &pp) const =0 |
Construct and return a clone 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< Field< Type > > | value (const scalar x) const |
Return value as a function of (scalar) independent variable. More... | |
virtual bool | constant () const =0 |
Is value constant (i.e. independent of x) More... | |
virtual bool | uniform () const =0 |
Is value uniform (i.e. independent of coordinate) More... | |
virtual tmp< Field< Type > > | integrate (const scalar x1, const scalar x2) const |
Integrate between two (scalar) values. 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... | |
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... | |
Static Public Member Functions | |
static autoPtr< PatchFunction1< Type > > | New (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true) |
Selector. More... | |
Public Attributes | |
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 | |
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... | |
Friends | |
Ostream & | operator (Ostream &os, const PatchFunction1< Type > &func) |
Ostream Operator. More... | |
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits.
Extends the Function1 class by adding autoMap and rMap functions
Definition at line 63 of file PatchFunction1.H.
typedef Field<Type> returnType |
Definition at line 106 of file PatchFunction1.H.
PatchFunction1 | ( | const polyPatch & | pp, |
const word & | entryName, | ||
const bool | faceValues = true |
||
) |
Construct from polyPatch and entry name.
PatchFunction1 | ( | const polyPatch & | pp, |
const word & | entryName, | ||
const dictionary & | dict, | ||
const bool | faceValues = true |
||
) |
Construct from polyPatch, dictionary and entry name.
|
explicit |
Copy constructor.
|
explicit |
Copy constructor setting patch.
|
virtualdefault |
Destructor.
TypeName | ( | "PatchFunction1< Type >" | ) |
Runtime type information.
Declare runtime constructor selection table
|
pure virtual |
Construct and return a clone.
Implemented in Sampled< Type >, MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
|
pure virtual |
Construct and return a clone setting patch.
Implemented in Sampled< Type >, MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
|
static |
Selector.
Definition at line 34 of file PatchFunction1New.C.
const Foam::word & name | ( | ) | const |
Return the name of the entry.
Definition at line 96 of file PatchFunction1.C.
const Foam::polyPatch & patch | ( | ) | const |
Reference to the patch.
Definition at line 103 of file PatchFunction1.C.
bool faceValues | ( | ) | const |
Whether to generate face or point values on patch.
|
virtual |
Convert time.
Definition at line 117 of file PatchFunction1.C.
|
virtual |
Return value as a function of (scalar) independent variable.
Reimplemented in MappedFile< Type >, Sampled< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Definition at line 123 of file PatchFunction1.C.
Is value constant (i.e. independent of x)
Implemented in Sampled< Type >, MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Is value uniform (i.e. independent of coordinate)
Implemented in Sampled< Type >, MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Definition at line 133 of file PatchFunction1.C.
Referenced by UniformValueField< Type >::uniform(), ConstantField< Type >::uniform(), and MappedFile< Type >::uniform().
|
virtual |
Integrate between two (scalar) values.
Reimplemented in Sampled< Type >, MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Definition at line 141 of file PatchFunction1.C.
|
virtual |
Helper: optionally convert coordinates to local coordinates.
Definition at line 154 of file PatchFunction1.C.
|
virtual |
Apply optional transformation.
Definition at line 190 of file PatchFunction1.C.
|
virtual |
Apply optional transformation.
Definition at line 167 of file PatchFunction1.C.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented in MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Definition at line 211 of file PatchFunction1.C.
|
virtual |
Reverse map the given PatchFunction1 onto this PatchFunction1.
Reimplemented in MappedFile< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Definition at line 217 of file PatchFunction1.C.
|
virtual |
Write in dictionary format.
Reimplemented in MappedFile< Type >, Sampled< Type >, CodedField< Type >, PatchExprField< Type >, ConstantField< Type >, and UniformValueField< Type >.
Definition at line 225 of file PatchFunction1.C.
|
friend |
Ostream Operator.
|
protected |
Name of entry.
Definition at line 92 of file PatchFunction1.H.
|
protected |
Reference to the patch.
Definition at line 95 of file PatchFunction1.H.
|
protected |
Whether to generate face or point values on patch.
Definition at line 98 of file PatchFunction1.H.
|
protected |
Optional local co-ordinate system and scaling.
Definition at line 101 of file PatchFunction1.H.
Definition at line 115 of file PatchFunction1.H.
Definition at line 116 of file PatchFunction1.H.
const polyPatch& pp |
Definition at line 118 of file PatchFunction1.H.
Referenced by UniformValueField< Type >::clone(), ConstantField< Type >::clone(), PatchExprField< Type >::clone(), CodedField< Type >::clone(), MappedFile< Type >::clone(), and Sampled< Type >::clone().
Definition at line 119 of file PatchFunction1.H.
Definition at line 120 of file PatchFunction1.H.
const polyPatch const word const word const dictionary& dict |
Definition at line 121 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool faceValues |
Definition at line 123 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool pp |
Definition at line 124 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool type |
Definition at line 124 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool entryName |
Definition at line 124 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool dict |
Definition at line 124 of file PatchFunction1.H.