Templated function that returns a uniform field based on a run-time selectable Function1 entry. More...
Public Member Functions | |
TypeName ("uniformValue") | |
void | operator= (const UniformValueField< Type > &)=delete |
No copy assignment. More... | |
UniformValueField (const polyPatch &pp, const word &redirectType, const word &entryName, const dictionary &dict, const bool faceValues=true) | |
Construct from entry name and dictionary. More... | |
UniformValueField (const UniformValueField< Type > &rhs, const polyPatch &pp) | |
Copy construct setting patch. More... | |
UniformValueField (const UniformValueField< Type > &rhs) | |
Copy construct. More... | |
virtual tmp< PatchFunction1< Type > > | clone () const |
Return a clone. More... | |
virtual tmp< PatchFunction1< Type > > | clone (const polyPatch &pp) const |
Return a clone, setting the patch. More... | |
virtual | ~UniformValueField ()=default |
Destructor. More... | |
virtual bool | constant () const |
Is value constant (i.e. independent of x) More... | |
virtual bool | good () const |
Can function be evaluated? More... | |
virtual bool | uniform () const |
Is value uniform (i.e. independent of coordinate) More... | |
virtual tmp< Field< Type > > | value (const scalar x) const |
Return UniformValueField value. 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 > &rhs, const polyPatch &pp) | |
Copy construct setting patch. More... | |
PatchFunction1 (const PatchFunction1< Type > &rhs) | |
Copy construct. More... | |
virtual | ~PatchFunction1 ()=default |
Destructor. 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... | |
Public Member Functions inherited from patchFunction1Base | |
patchFunction1Base (const polyPatch &pp, const word &entryName, const bool faceValues=true) | |
Construct from polyPatch and entry name. More... | |
patchFunction1Base (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true) | |
Construct from polyPatch, dictionary and entry name. More... | |
patchFunction1Base (const patchFunction1Base &rhs) | |
Copy construct. More... | |
patchFunction1Base (const patchFunction1Base &rhs, const polyPatch &pp) | |
Copy construct setting patch. More... | |
virtual | ~patchFunction1Base ()=default |
Destructor. More... | |
const word & | name () const noexcept |
The name of the entry. More... | |
const polyPatch & | patch () const noexcept |
Reference to the patch. More... | |
bool | faceValues () const noexcept |
Generate face or point values on patch? More... | |
label | size () const |
Number of faces or points on the patch. More... | |
const objectRegistry * | whichDb () const |
Return the associated registry (ie, the mesh) More... | |
const objectRegistry & | obr () const |
Return the object registry (ie, the mesh) More... | |
const Time & | time () const |
Return false: function not created with time database. More... | |
virtual void | userTimeToTime (const Time &t) |
Convert time. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | use_count () const noexcept |
Return the current reference count. More... | |
bool | unique () const noexcept |
Return true if the reference count is zero. More... | |
void | operator++ () noexcept |
Increment the reference count. More... | |
void | operator++ (int) noexcept |
Increment the reference count. More... | |
void | operator-- () noexcept |
Decrement the reference count. More... | |
void | operator-- (int) noexcept |
Decrement the reference count. More... | |
Additional Inherited Members | |
Public Types inherited from PatchFunction1< Type > | |
typedef Field< Type > | returnType |
The return type is a field of values. More... | |
Static Public Member Functions inherited from PatchFunction1< Type > | |
template<class Derived > | |
static tmp< PatchFunction1< Type > > | Clone (const Derived &fun) |
Clone a PatchFunction1. More... | |
template<class Derived > | |
static tmp< PatchFunction1< Type > > | Clone (const Derived &fun, const polyPatch &pp) |
Clone a PatchFunction1 with a patch. More... | |
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... | |
static refPtr< PatchFunction1< Type > > | New (HashPtrTable< PatchFunction1< Type >> &cache, const polyPatch &pp, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const bool faceValues=true, const bool mandatory=true) |
Selector with external storage. This also allows wildcard matches in a dictionary. 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 Member Functions inherited from PatchFunction1< Type > | |
void | operator= (const PatchFunction1< Type > &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from patchFunction1Base | |
void | operator= (const patchFunction1Base &)=delete |
No copy assignment. More... | |
Protected Attributes inherited from PatchFunction1< Type > | |
coordinateScaling< Type > | coordSys_ |
Optional local coordinate system and scaling. More... | |
Protected Attributes inherited from patchFunction1Base | |
const word | name_ |
Name of entry. More... | |
const polyPatch & | patch_ |
Reference to the patch. More... | |
const bool | faceValues_ |
Generate face or point values on patch. More... | |
Templated function that returns a uniform field based on a run-time selectable Function1 entry.
Usage - for entry <entryName> returning the value
:
<entryName> uniformValue
Definition at line 56 of file UniformValueField.H.
UniformValueField | ( | const polyPatch & | pp, |
const word & | redirectType, | ||
const word & | entryName, | ||
const dictionary & | dict, | ||
const bool | faceValues = true |
||
) |
Construct from entry name and dictionary.
Definition at line 28 of file UniformValueField.C.
|
explicit |
Copy construct setting patch.
Definition at line 52 of file UniformValueField.C.
|
explicit |
Copy construct.
Definition at line 69 of file UniformValueField.C.
|
virtualdefault |
Destructor.
TypeName | ( | "uniformValue" | ) |
|
delete |
No copy assignment.
|
inlinevirtual |
Return a clone.
Implements PatchFunction1< Type >.
Definition at line 113 of file UniformValueField.H.
References PatchFunction1< Type >::Clone().
|
inlinevirtual |
Return a clone, setting the patch.
Implements PatchFunction1< Type >.
Definition at line 121 of file UniformValueField.H.
References PatchFunction1< Type >::Clone(), and PatchFunction1< Type >::pp.
|
inlinevirtual |
Is value constant (i.e. independent of x)
Reimplemented from PatchFunction1< Type >.
Definition at line 138 of file UniformValueField.H.
|
inlinevirtual |
Can function be evaluated?
Reimplemented from PatchFunction1< Type >.
Definition at line 146 of file UniformValueField.H.
References autoPtr< T >::good().
|
inlinevirtual |
Is value uniform (i.e. independent of coordinate)
Implements PatchFunction1< Type >.
Definition at line 154 of file UniformValueField.H.
References PatchFunction1< Type >::uniform().
|
inlinevirtual |
Return UniformValueField value.
Reimplemented from PatchFunction1< Type >.
Definition at line 29 of file UniformValueFieldI.H.
References Foam::New(), Foam::transform(), and x.
|
inlinevirtual |
Integrate between two values.
Reimplemented from PatchFunction1< Type >.
Definition at line 47 of file UniformValueFieldI.H.
References Foam::New(), and Foam::transform().
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented from PatchFunction1< Type >.
Definition at line 81 of file UniformValueField.C.
|
virtual |
Reverse map the given PatchFunction1 onto this PatchFunction1.
Reimplemented from PatchFunction1< Type >.
Definition at line 89 of file UniformValueField.C.
|
virtual |
Write in dictionary format.
Reimplemented from PatchFunction1< Type >.
Definition at line 98 of file UniformValueField.C.
References os(), and writeData().