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 > &rhs) | |
Copy construct. More... | |
PatchFunction1 (const PatchFunction1< Type > &rhs, const polyPatch &pp) | |
Copy construct setting patch. More... | |
virtual tmp< PatchFunction1< Type > > | clone () const =0 |
Return a clone. More... | |
virtual tmp< PatchFunction1< Type > > | clone (const polyPatch &pp) const =0 |
Return a clone, setting patch. More... | |
virtual | ~PatchFunction1 ()=default |
Destructor. 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 > &rhs, 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, const bool mandatory=true) |
Selector. More... | |
static autoPtr< PatchFunction1< Type > > | NewCompat (const polyPatch &pp, const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const bool faceValues=true, const bool mandatory=true) |
Compatibility selector. More... | |
static autoPtr< PatchFunction1< Type > > | NewIfPresent (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true) |
An optional 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 Member Functions | |
void | operator= (const PatchFunction1< Type > &)=delete |
No copy assignment. More... | |
Protected Attributes | |
coordinateScaling< Type > | coordSys_ |
Optional local co-ordinate system and scaling. More... | |
Friends | |
Ostream & | operator (Ostream &os, const PatchFunction1< Type > &rhs) |
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 59 of file PatchFunction1.H.
typedef Field<Type> returnType |
Definition at line 103 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 construct.
|
explicit |
Copy construct setting patch.
|
virtualdefault |
Destructor.
|
protecteddelete |
No copy assignment.
TypeName | ( | "PatchFunction1< Type >" | ) |
Runtime type information.
Declare runtime constructor selection table
|
pure virtual |
Return a clone.
Implemented in Sampled< Type >, MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
|
pure virtual |
Return a clone, setting patch.
Implemented in Sampled< Type >, MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
|
static |
Selector.
Definition at line 162 of file PatchFunction1New.C.
|
static |
Compatibility selector.
Definition at line 185 of file PatchFunction1New.C.
|
static |
An optional selector.
Definition at line 209 of file PatchFunction1New.C.
|
virtual |
Return value as a function of (scalar) independent variable.
Reimplemented in MappedFile< Type >, MappedFile< scalar >, Sampled< Type >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
Definition at line 84 of file PatchFunction1.C.
Is value constant (i.e. independent of x)
Implemented in Sampled< Type >, MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
Is value uniform (i.e. independent of coordinate)
Implemented in Sampled< Type >, MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
Definition at line 93 of file PatchFunction1.C.
Referenced by UniformValueField< Type >::uniform(), ConstantField< Type >::uniform(), and MappedFile< scalar >::uniform().
|
virtual |
Integrate between two (scalar) values.
Reimplemented in Sampled< Type >, MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
Definition at line 101 of file PatchFunction1.C.
|
virtual |
Helper: optionally convert coordinates to local coordinates.
Definition at line 113 of file PatchFunction1.C.
|
virtual |
Apply optional transformation.
Definition at line 149 of file PatchFunction1.C.
|
virtual |
Apply optional transformation.
Definition at line 126 of file PatchFunction1.C.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented in MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
Definition at line 170 of file PatchFunction1.C.
|
virtual |
Reverse map the given PatchFunction1 onto this PatchFunction1.
Reimplemented in MappedFile< Type >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, UniformValueField< Type >, and MappedFile< scalar >.
Definition at line 176 of file PatchFunction1.C.
|
virtual |
Write in dictionary format.
Reimplemented in Sampled< Type >, MappedFile< Type >, MappedFile< scalar >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.
Definition at line 184 of file PatchFunction1.C.
|
friend |
Ostream Operator.
|
protected |
Optional local co-ordinate system and scaling.
Definition at line 92 of file PatchFunction1.H.
Definition at line 112 of file PatchFunction1.H.
Definition at line 113 of file PatchFunction1.H.
const polyPatch& pp |
Definition at line 115 of file PatchFunction1.H.
Referenced by UniformValueField< Type >::clone(), PatchExprField< Type >::clone(), ConstantField< Type >::clone(), CodedField< Type >::clone(), MappedFile< scalar >::clone(), and Sampled< Type >::clone().
Definition at line 116 of file PatchFunction1.H.
Definition at line 117 of file PatchFunction1.H.
const polyPatch const word const word const dictionary& dict |
Definition at line 118 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool faceValues |
Definition at line 120 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool pp |
Definition at line 121 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool type |
Definition at line 121 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool entryName |
Definition at line 121 of file PatchFunction1.H.
const polyPatch const word const word const dictionary const bool dict |
Definition at line 121 of file PatchFunction1.H.