Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
patchFunction1Base Class Reference

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...

Inheritance diagram for patchFunction1Base:
[legend]
Collaboration diagram for patchFunction1Base:
[legend]

Public Member Functions

 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
 The name of the entry. More...
 
const polyPatch & patch () const
 Reference to the patch. More...
 
bool faceValues () const
 Generate face or point values on patch? More...
 
label size () const
 Number of faces or points on the patch. More...
 
virtual void convertTimeBase (const Time &)
 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...
 

Protected Member Functions

void operator= (const patchFunction1Base &)=delete
 No copy assignment. More...
 

Protected Attributes

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...
 

Detailed Description

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

Source files

Definition at line 59 of file patchFunction1Base.H.

Constructor & Destructor Documentation

◆ patchFunction1Base() [1/4]

patchFunction1Base ( const polyPatch &  pp,
const word &  entryName,
const bool  faceValues = true 
)

Construct from polyPatch and entry name.

Definition at line 35 of file patchFunction1Base.C.

◆ patchFunction1Base() [2/4]

patchFunction1Base ( const polyPatch &  pp,
const word &  entryName,
const dictionary &  dict,
const bool  faceValues = true 
)

Construct from polyPatch, dictionary and entry name.

Definition at line 49 of file patchFunction1Base.C.

◆ patchFunction1Base() [3/4]

patchFunction1Base ( const patchFunction1Base &  rhs)
explicit

Copy construct.

Definition at line 63 of file patchFunction1Base.C.

◆ patchFunction1Base() [4/4]

patchFunction1Base ( const patchFunction1Base &  rhs,
const polyPatch &  pp 
)
explicit

Copy construct setting patch.

Definition at line 70 of file patchFunction1Base.C.

◆ ~patchFunction1Base()

virtual ~patchFunction1Base ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const patchFunction1Base &  )
protecteddelete

No copy assignment.

◆ name()

const word& name ( ) const
inline

The name of the entry.

Definition at line 124 of file patchFunction1Base.H.

References patchFunction1Base::name_.

◆ patch()

const polyPatch& patch ( ) const
inline

Reference to the patch.

Definition at line 130 of file patchFunction1Base.H.

References patchFunction1Base::patch_.

◆ faceValues()

bool faceValues ( ) const
inline

Generate face or point values on patch?

Definition at line 136 of file patchFunction1Base.H.

References patchFunction1Base::faceValues_.

◆ size()

label size ( ) const
inline

Number of faces or points on the patch.

Definition at line 142 of file patchFunction1Base.H.

References patchFunction1Base::faceValues_, PrimitivePatch< FaceList, PointField >::nPoints(), and patchFunction1Base::patch_.

Here is the call graph for this function:

◆ convertTimeBase()

void convertTimeBase ( const Time &  )
virtual

Convert time.

Definition at line 84 of file patchFunction1Base.C.

Member Data Documentation

◆ name_

const word name_
protected

Name of entry.

Definition at line 68 of file patchFunction1Base.H.

Referenced by patchFunction1Base::name().

◆ patch_

const polyPatch& patch_
protected

Reference to the patch.

Definition at line 71 of file patchFunction1Base.H.

Referenced by patchFunction1Base::patch(), and patchFunction1Base::size().

◆ faceValues_

const bool faceValues_
protected

Generate face or point values on patch.

Definition at line 74 of file patchFunction1Base.H.

Referenced by patchFunction1Base::faceValues(), and patchFunction1Base::size().

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