Loading...
Searching...
No Matches
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...

#include <patchFunction1Base.H>

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

Public Member Functions

 patchFunction1Base (const polyPatch &pp, const word &entryName, const bool faceValues=true)
 Construct from polyPatch and entry name.
 patchFunction1Base (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)
 Construct from polyPatch, dictionary and entry name.
 patchFunction1Base (const patchFunction1Base &rhs)
 Copy construct.
 patchFunction1Base (const patchFunction1Base &rhs, const polyPatch &pp)
 Copy construct setting patch.
virtual ~patchFunction1Base ()=default
 Destructor.
const word & name () const noexcept
 The name of the entry.
const polyPatch & patch () const noexcept
 Reference to the patch.
bool faceValues () const noexcept
 Generate face or point values on patch?
label size () const
 Number of faces or points on the patch.
const objectRegistry * whichDb () const
 Return the associated registry (ie, the mesh).
const objectRegistry & obr () const
 Return the object registry (ie, the mesh).
const Time & time () const
 Return false: function not created with time database.
virtual void userTimeToTime (const Time &t)
 Convert time.
Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0.
int use_count () const noexcept
 Return the current reference count.
bool unique () const noexcept
 Return true if the reference count is zero.
void operator++ () noexcept
 Increment the reference count.
void operator++ (int) noexcept
 Increment the reference count.
void operator-- () noexcept
 Decrement the reference count.
void operator-- (int) noexcept
 Decrement the reference count.

Protected Member Functions

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

Protected Attributes

const word name_
 Name of entry.
const polyPatch & patch_
 Reference to the patch.
const bool faceValues_
 Generate face or point values on patch.

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 56 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 30 of file patchFunction1Base.C.

References faceValues(), faceValues_, name_, patch_, pp(), and refCount::refCount().

Referenced by operator=(), patchFunction1Base(), patchFunction1Base(), and UniformValueField< Type >::UniformValueField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 44 of file patchFunction1Base.C.

References dict, faceValues(), faceValues_, name_, patch_, pp(), and refCount::refCount().

Here is the call graph for this function:

◆ patchFunction1Base() [3/4]

patchFunction1Base ( const patchFunction1Base & rhs)
explicit

Copy construct.

Definition at line 59 of file patchFunction1Base.C.

References patch(), patchFunction1Base(), and Foam::rhs().

Here is the call graph for this function:

◆ patchFunction1Base() [4/4]

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

Copy construct setting patch.

Definition at line 65 of file patchFunction1Base.C.

References faceValues_, name_, patch_, patchFunction1Base(), pp(), refCount::refCount(), and Foam::rhs().

Here is the call graph for this function:

◆ ~patchFunction1Base()

virtual ~patchFunction1Base ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const patchFunction1Base & )
protecteddelete

No copy assignment.

References dict, faceValues(), patchFunction1Base(), pp(), and Foam::rhs().

Here is the call graph for this function:

◆ name()

const word & name ( ) const
inlinenoexcept

The name of the entry.

Definition at line 141 of file patchFunction1Base.H.

References name_, and Foam::noexcept.

◆ patch()

const polyPatch & patch ( ) const
inlinenoexcept

Reference to the patch.

Definition at line 149 of file patchFunction1Base.H.

References Foam::noexcept, and patch_.

Referenced by MappedFile< Type >::clone(), CodedField< Type >::CodedField(), ConstantField< Type >::ConstantField(), LookupField< Type >::LookupField(), MappedFile< Type >::MappedFile(), PatchExprField< Type >::PatchExprField(), PatchExprField< Type >::PatchExprField(), PatchExprField< Type >::PatchExprField(), patchFunction1Base(), Sampled< Type >::Sampled(), UniformValueField< Type >::UniformValueField(), and LookupField< Type >::value().

Here is the caller graph for this function:

◆ faceValues()

bool faceValues ( ) const
inlinenoexcept

Generate face or point values on patch?

Definition at line 157 of file patchFunction1Base.H.

References faceValues_, and Foam::noexcept.

Referenced by operator=(), patchFunction1Base(), and patchFunction1Base().

Here is the caller graph for this function:

◆ size()

label size ( ) const
inline

Number of faces or points on the patch.

Definition at line 165 of file patchFunction1Base.H.

References faceValues_, and patch_.

Referenced by ConstantField< Type >::ConstantField(), ConstantField< Type >::ConstantField(), ConstantField< Type >::ConstantField(), ConstantField< Type >::ConstantField(), UniformValueField< Type >::integrate(), MappedFile< Type >::rmap(), LookupField< Type >::value(), Sampled< Type >::value(), and UniformValueField< Type >::value().

Here is the caller graph for this function:

◆ whichDb()

const Foam::objectRegistry * whichDb ( ) const

Return the associated registry (ie, the mesh).

Definition at line 80 of file patchFunction1Base.C.

References mesh, and patch_.

Referenced by UniformValueField< Type >::UniformValueField(), and UniformValueField< Type >::UniformValueField().

Here is the caller graph for this function:

◆ obr()

const Foam::objectRegistry & obr ( ) const

Return the object registry (ie, the mesh).

Definition at line 86 of file patchFunction1Base.C.

References patch_.

Referenced by LookupField< Type >::value().

Here is the caller graph for this function:

◆ time()

const Foam::Time & time ( ) const

Return false: function not created with time database.

/ bool isTime() const noexcept / { / return false; / }

Return the time database

Definition at line 92 of file patchFunction1Base.C.

References patch_.

Referenced by MappedFile< scalar >::value().

Here is the caller graph for this function:

◆ userTimeToTime()

void userTimeToTime ( const Time & t)
virtual

Convert time.

Definition at line 98 of file patchFunction1Base.C.

Member Data Documentation

◆ name_

const word name_
protected

Name of entry.

Definition at line 67 of file patchFunction1Base.H.

Referenced by name(), patchFunction1Base(), patchFunction1Base(), and patchFunction1Base().

◆ patch_

const polyPatch& patch_
protected

Reference to the patch.

Definition at line 72 of file patchFunction1Base.H.

Referenced by CodedField< Type >::libs(), obr(), patch(), patchFunction1Base(), patchFunction1Base(), patchFunction1Base(), CodedField< Type >::prepare(), size(), time(), PatchFunction1< Type >::transform(), PatchFunction1< Type >::transform(), MappedFile< Type >::value(), MappedFile< scalar >::value(), whichDb(), and MappedFile< scalar >::writeData().

◆ faceValues_

const bool faceValues_
protected

Generate face or point values on patch.

Definition at line 77 of file patchFunction1Base.H.

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

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