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 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	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 60 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 38 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 52 of file patchFunction1Base.C.

◆ patchFunction1Base() [3/4]

patchFunction1Base ( const patchFunction1Base & rhs )

explicit

Copy construct.

Definition at line 66 of file patchFunction1Base.C.

◆ patchFunction1Base() [4/4]

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

explicit

Copy construct setting patch.

Definition at line 73 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

inlinenoexcept

The name of the entry.

Definition at line 125 of file patchFunction1Base.H.

References patchFunction1Base::name_.

◆ patch()

const polyPatch& patch ( ) const

inlinenoexcept

Reference to the patch.

Definition at line 131 of file patchFunction1Base.H.

References patchFunction1Base::patch_.

◆ faceValues()

bool faceValues ( ) const

inlinenoexcept

Generate face or point values on patch?

Definition at line 137 of file patchFunction1Base.H.

References patchFunction1Base::faceValues_.

◆ size()

label size ( ) const

inline

Number of faces or points on the patch.

Definition at line 143 of file patchFunction1Base.H.

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

Here is the call graph for this function:

◆ whichDb()

const Foam::objectRegistry * whichDb ( ) const

Return the associated registry (ie, the mesh)

Definition at line 87 of file patchFunction1Base.C.

◆ obr()

const Foam::objectRegistry & obr ( ) const

Return the object registry (ie, the mesh)

Definition at line 93 of file patchFunction1Base.C.

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

References objectRegistry::time().

Here is the call graph for this function:

◆ userTimeToTime()

void userTimeToTime ( const Time & t )

virtual

Convert time.

Definition at line 105 of file patchFunction1Base.C.

Member Data Documentation

◆ name_

const word name_

protected

Name of entry.

Definition at line 69 of file patchFunction1Base.H.

Referenced by patchFunction1Base::name().

◆ patch_

const polyPatch& patch_

protected

Reference to the patch.

Definition at line 72 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 75 of file patchFunction1Base.H.

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

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

src/meshTools/PatchFunction1/PatchFunction1/patchFunction1Base.H
src/meshTools/PatchFunction1/PatchFunction1/patchFunction1Base.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ patchFunction1Base() [1/4]

◆ patchFunction1Base() [2/4]

◆ patchFunction1Base() [3/4]

◆ patchFunction1Base() [4/4]

◆ ~patchFunction1Base()

Member Function Documentation

◆ operator=()

◆ name()

◆ patch()

◆ faceValues()

◆ size()

◆ whichDb()

◆ obr()

◆ time()

◆ userTimeToTime()

Member Data Documentation

◆ name_

◆ patch_

◆ faceValues_