ConstantField< Type > Class Template Reference

Templated function that returns a constant value. More...

Inheritance diagram for ConstantField< Type >:
[legend]
Collaboration diagram for ConstantField< Type >:
[legend]

Public Member Functions

 TypeName ("constant")
 Runtime type information. More...
 
 ConstantField (const polyPatch &pp, const word &entryName, const Type &uniformValue, const dictionary &dict=dictionary::null, const bool faceValues=true)
 Construct from a uniform value. More...
 
 ConstantField (const polyPatch &pp, const word &entryName, const bool isUniform, const Type &uniformValue, const Field< Type > &fieldValues, const dictionary &dict=dictionary::null, const bool faceValues=true)
 Construct from components. More...
 
 ConstantField (const polyPatch &pp, const word &redirectType, const word &entryName, const dictionary &dict, const bool faceValues=true)
 Construct from entry name and dictionary. More...
 
 ConstantField (const polyPatch &pp, const entry *eptr, const word &entryName, const dictionary &dict, const bool faceValues=true)
 Construct from primitive entry, entry name and dictionary. More...
 
 ConstantField (const ConstantField< Type > &rhs)
 Copy construct. More...
 
 ConstantField (const ConstantField< Type > &rhs, const polyPatch &pp)
 Copy construct 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 ~ConstantField ()=default
 Destructor. More...
 
virtual bool constant () const
 Value is independent of x. More...
 
virtual bool uniform () const
 Is value uniform (i.e. independent of coordinate) More...
 
virtual tmp< Field< Type > > value (const scalar x) const
 Return constant 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)
 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 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 =0
 Is value uniform (i.e. independent of coordinate) More...
 
virtual tmp< Field< Type > > value (const scalar x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< Type > > integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual tmp< pointFieldlocalPosition (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...
 
- 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 wordname () const noexcept
 The name of the entry. More...
 
const polyPatchpatch () 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 objectRegistrywhichDb () const
 Return the associated registry (ie, the mesh) More...
 
const objectRegistryobr () const
 Return the object registry (ie, the mesh) More...
 
const Timetime () 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 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
 
- 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, 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)
 
- Public Attributes inherited from PatchFunction1< Type >
 PatchFunction1
 
 dictionary
 
const polyPatchpp
 
const polyPatch const wordtype
 
const polyPatch const word const wordentryName
 
const polyPatch const word const word const dictionarydict
 
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 polyPatchpatch_
 Reference to the patch. More...
 
const bool faceValues_
 Generate face or point values on patch. More...
 

Detailed Description

template<class Type>
class Foam::PatchFunction1Types::ConstantField< Type >

Templated function that returns a constant value.

Usage - for entry <entryName> returning the value

:

    <entryName>    constant  <value>
Source files

Definition at line 58 of file ConstantField.H.

Constructor & Destructor Documentation

◆ ConstantField() [1/6]

ConstantField ( const polyPatch pp,
const word entryName,
const Type &  uniformValue,
const dictionary dict = dictionary::null,
const bool  faceValues = true 
)

Construct from a uniform value.

Definition at line 33 of file ConstantField.C.

◆ ConstantField() [2/6]

ConstantField ( const polyPatch pp,
const word entryName,
const bool  isUniform,
const Type &  uniformValue,
const Field< Type > &  fieldValues,
const dictionary dict = dictionary::null,
const bool  faceValues = true 
)

Construct from components.

Definition at line 50 of file ConstantField.C.

References PatchFunction1< Type >::dict, Foam::exit(), PatchFunction1< Type >::faceValues, Foam::FatalIOError, FatalIOErrorInFunction, patchIdentifier::name(), Foam::nl, patchFunction1Base::size(), and UList< T >::size().

Here is the call graph for this function:

◆ ConstantField() [3/6]

ConstantField ( 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 168 of file ConstantField.C.

◆ ConstantField() [4/6]

ConstantField ( const polyPatch pp,
const entry eptr,
const word entryName,
const dictionary dict,
const bool  faceValues = true 
)

Construct from primitive entry, entry name and dictionary.

Definition at line 195 of file ConstantField.C.

◆ ConstantField() [5/6]

ConstantField ( const ConstantField< Type > &  rhs)
explicit

Copy construct.

Definition at line 222 of file ConstantField.C.

◆ ConstantField() [6/6]

ConstantField ( const ConstantField< Type > &  rhs,
const polyPatch pp 
)
explicit

Copy construct setting patch.

Definition at line 232 of file ConstantField.C.

References patchFunction1Base::size(), and Foam::Zero.

Here is the call graph for this function:

◆ ~ConstantField()

virtual ~ConstantField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "constant"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< PatchFunction1< Type > > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements PatchFunction1< Type >.

Definition at line 151 of file ConstantField.H.

◆ clone() [2/2]

virtual tmp< PatchFunction1< Type > > clone ( const polyPatch pp) const
inlinevirtual

Construct and return a clone setting patch.

Implements PatchFunction1< Type >.

Definition at line 157 of file ConstantField.H.

References PatchFunction1< Type >::pp.

◆ constant()

virtual bool constant ( ) const
inlinevirtual

Value is independent of x.

Reimplemented from PatchFunction1< Type >.

Definition at line 173 of file ConstantField.H.

◆ uniform()

virtual bool uniform ( ) const
inlinevirtual

Is value uniform (i.e. independent of coordinate)

Implements PatchFunction1< Type >.

Definition at line 179 of file ConstantField.H.

References PatchFunction1< Type >::uniform().

Here is the call graph for this function:

◆ value()

Foam::tmp< Foam::Field< Type > > value ( const scalar  x) const
inlinevirtual

Return constant value.

Reimplemented from PatchFunction1< Type >.

Definition at line 34 of file ConstantFieldI.H.

References Foam::transform().

Here is the call graph for this function:

◆ integrate()

Foam::tmp< Foam::Field< Type > > integrate ( const scalar  x1,
const scalar  x2 
) const
inlinevirtual

Integrate between two values.

Reimplemented from PatchFunction1< Type >.

Definition at line 50 of file ConstantFieldI.H.

References Foam::transform().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const FieldMapper mapper)
virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from PatchFunction1< Type >.

Definition at line 256 of file ConstantField.C.

◆ rmap()

void rmap ( const PatchFunction1< Type > &  pf1,
const labelList addr 
)
virtual

Reverse map the given PatchFunction1 onto this PatchFunction1.

Reimplemented from PatchFunction1< Type >.

Definition at line 272 of file ConstantField.C.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from PatchFunction1< Type >.

Definition at line 284 of file ConstantField.C.

References Foam::name(), os(), and token::SPACE.

Here is the call graph for this function:

The documentation for this class was generated from the following files: