Run-time selectable function of two variables. More...
Public Types | |
typedef Type | returnType |
Public Member Functions | |
TypeName ("Function2") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict)) | |
declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is)) | |
Function2 (const word &name) | |
Construct from name. More... | |
Function2 (const Function2< Type > &f2) | |
Copy constructor. More... | |
virtual tmp< Function2< Type > > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~Function2 () |
Destructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
virtual Type | value (const scalar x, const scalar y) const =0 |
Return value as a function of two scalars. More... | |
virtual tmp< Field< Type > > | value (const scalarField &x, const scalarField &y) const =0 |
Return value as a function of two scalar fields. More... | |
virtual void | write (Ostream &os, const Function2s::unitConversions &) const =0 |
Write in dictionary format. More... | |
void | operator= (const Function2< Type > &) |
Assignment. More... | |
![]() | |
int | count () const |
Return the current reference count. More... | |
bool | unique () const |
Return true if the reference count is zero. More... | |
void | operator++ () |
Increment the reference count. More... | |
void | operator++ (int) |
Increment the reference count. More... | |
void | operator-- () |
Decrement the reference count. More... | |
void | operator-- (int) |
Decrement the reference count. More... | |
void | operator= (const refCount &)=delete |
Disallow bitwise assignment. More... | |
Static Public Member Functions | |
static autoPtr< Function2< Type > > | New (const word &name, const Function2s::unitConversions &units, const dictionary &dict) |
Select from dictionary. More... | |
static autoPtr< Function2< Type > > | New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict) |
Select from dictionary. More... | |
static autoPtr< Function2< Type > > | New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is) |
Select from Istream. More... | |
static autoPtr< Function2< Type > > | New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is) |
Select from Istream. More... | |
Protected Attributes | |
const word | name_ |
Name of entry. More... | |
Friends | |
Ostream & | operator (Ostream &os, const Function2< Type > &func) |
Ostream Operator. More... | |
Additional Inherited Members | |
![]() | |
refCount () | |
Construct null initialising count to 0. More... | |
refCount (const refCount &)=delete | |
Disallow copy. More... | |
Run-time selectable function of two variables.
Macros for creating standard Function2-s.
with many options provided from simple constant values to complex functions, interpolated tabulated data etc. etc.
Definition at line 95 of file Function2.H.
typedef Type returnType |
Definition at line 110 of file Function2.H.
Construct from name.
Definition at line 31 of file Function2.C.
Copy constructor.
Definition at line 38 of file Function2.C.
|
virtual |
Destructor.
Definition at line 66 of file Function2.C.
TypeName | ( | "Function2< Type >" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
Function2< Type > | , | ||
dictionary | , | ||
(const word &name, const Function2s::unitConversions &units, const dictionary &dict) | , | ||
(name, units, dict) | |||
) |
declareRunTimeSelectionTable | ( | autoPtr | , |
Function2< Type > | , | ||
Istream | , | ||
(const word &name, const Function2s::unitConversions &units, Istream &is) | , | ||
(name, units, is) | |||
) |
Construct and return a clone.
Implemented in APIdiffCoef, FieldFunction2< Type, Function2Type >, FieldFunction2< Type, Scale< Type > >, FieldFunction2< Type, Constant< Type > >, FieldFunction2< Type, UniformTable< Type > >, FieldFunction2< Type, Product< Type > >, FieldFunction2< Type, None< Type > >, FieldFunction2< Type, OneConstant< Type > >, FieldFunction2< Type, Function12< Type > >, FieldFunction2< Type, Radial< Type > >, FieldFunction2< scalar, APIdiffCoef >, FieldFunction2< Type, ZeroConstant< Type > >, Constant< Type >, and Coded< Type >.
|
static |
Select from dictionary.
Definition at line 31 of file Function2New.C.
References dict, IOstream::eof(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, token::isWord(), dictionary::lookup(), Foam::name(), Foam::compressible::New(), Foam::nl, Istream::putBack(), and Foam::units().
Referenced by swirlFlowRateInletVelocityFvPatchVectorField::swirlFlowRateInletVelocityFvPatchVectorField(), and swirlInletVelocityFvPatchVectorField::swirlInletVelocityFvPatchVectorField().
|
static |
Select from dictionary.
Definition at line 100 of file Function2New.C.
References dict, Foam::name(), and Foam::compressible::New().
|
static |
Select from Istream.
Definition at line 114 of file Function2New.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, and Foam::units().
|
static |
Select from Istream.
Definition at line 157 of file Function2New.C.
References Foam::name(), and Foam::compressible::New().
const Foam::word & name |
Return the name of the entry.
Definition at line 78 of file Function2.C.
Referenced by Foam::writeEntry().
|
pure virtual |
Return value as a function of two scalars.
Implemented in UniformTable< Type >, UniformTable< scalar >, APIdiffCoef, FieldFunction2< Type, Scale< Type > >, FieldFunction2< Type, Constant< Type > >, FieldFunction2< Type, UniformTable< Type > >, FieldFunction2< Type, Product< Type > >, FieldFunction2< Type, None< Type > >, FieldFunction2< Type, OneConstant< Type > >, FieldFunction2< Type, Function12< Type > >, FieldFunction2< Type, Radial< Type > >, FieldFunction2< scalar, APIdiffCoef >, FieldFunction2< Type, ZeroConstant< Type > >, FieldFunction2< Type, Function2Type >, ZeroConstant< Type >, Scale< Type >, Radial< Type >, Product< Type >, OneConstant< Type >, None< Type >, Function12< Type >, Constant< Type >, and Coded< Type >.
|
pure virtual |
Return value as a function of two scalar fields.
Implemented in ZeroConstant< Type >, OneConstant< Type >, FieldFunction2< Type, Function2Type >, FieldFunction2< Type, Scale< Type > >, FieldFunction2< Type, Constant< Type > >, FieldFunction2< Type, UniformTable< Type > >, FieldFunction2< Type, Product< Type > >, FieldFunction2< Type, None< Type > >, FieldFunction2< Type, OneConstant< Type > >, FieldFunction2< Type, Function12< Type > >, FieldFunction2< Type, Radial< Type > >, FieldFunction2< scalar, APIdiffCoef >, FieldFunction2< Type, ZeroConstant< Type > >, Constant< Type >, and Coded< Type >.
|
pure virtual |
Write in dictionary format.
Implemented in APIdiffCoef, ZeroConstant< Type >, UniformTable< Type >, UniformTable< scalar >, Scale< Type >, Radial< Type >, Product< Type >, OneConstant< Type >, None< Type >, Function12< Type >, Constant< Type >, and Coded< Type >.
Referenced by Foam::writeEntry().
Assignment.
Definition at line 106 of file Function2.C.
References Foam::abort(), f(), Foam::FatalError, and FatalErrorInFunction.
|
protected |
Name of entry.
Definition at line 105 of file Function2.H.
Referenced by UniformTable< Type >::UniformTable().