faPatchFieldBase Class Reference

Template invariant parts for faPatchField. More...

Inheritance diagram for faPatchFieldBase:

Public Member Functions
	TypeName ("faPatchField")
	Runtime type information. More...
	faPatchFieldBase (const faPatch &p)
	Construct from patch. More...
	faPatchFieldBase (const faPatch &p, const word &patchType)
	Construct from patch and patch type. More...
	faPatchFieldBase (const faPatch &p, const dictionary &dict)
	Construct from patch and dictionary. More...
	faPatchFieldBase (const faPatchFieldBase &rhs, const faPatch &p)
	Copy construct with new patch. More...
	faPatchFieldBase (const faPatchFieldBase &rhs)
	Copy construct. More...
virtual	~faPatchFieldBase ()=default
	Destructor. More...
const faPatch &	patch () const noexcept
	The associated objectRegistry. More...
const word &	patchType () const noexcept
	The optional patch type. More...
word &	patchType () noexcept
	The optional patch type. More...
bool	updated () const noexcept
	True if the boundary condition has already been updated. More...
void	checkPatch (const faPatchFieldBase &rhs) const
	Check that patches are identical. More...

Static Public Attributes
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic faPatchField. More...

Protected Member Functions
virtual void	readDict (const dictionary &dict)
	Read dictionary entries. More...
void	setUpdated (bool state) noexcept
	Set updated state. More...

Detailed Description

Template invariant parts for faPatchField.

Definition at line 74 of file faPatchField.H.

Constructor & Destructor Documentation

faPatchFieldBase() [1/5]

faPatchFieldBase ( const faPatch &  p )

explicit

Construct from patch.

Definition at line 39 of file faPatchFieldBase.C.

faPatchFieldBase() [2/5]

faPatchFieldBase ( const faPatch &  p, const word &  patchType  )

explicit

Construct from patch and patch type.

Definition at line 48 of file faPatchFieldBase.C.

faPatchFieldBase() [3/5]

faPatchFieldBase	(	const faPatch &	p,
		const dictionary &	dict
	)

Construct from patch and dictionary.

Definition at line 60 of file faPatchFieldBase.C.

References dict, and faPatchFieldBase::readDict().

Here is the call graph for this function:

faPatchFieldBase() [4/5]

faPatchFieldBase	(	const faPatchFieldBase &	rhs,
		const faPatch &	p
	)

Copy construct with new patch.

Definition at line 72 of file faPatchFieldBase.C.

faPatchFieldBase() [5/5]

faPatchFieldBase

(

const faPatchFieldBase &

rhs

)

Copy construct.

Definition at line 83 of file faPatchFieldBase.C.

~faPatchFieldBase()

virtual ~faPatchFieldBase ( )

virtualdefault

Destructor.

Member Function Documentation

readDict()

void readDict ( const dictionary &  dict )

protectedvirtual

Read dictionary entries.

Useful when initially constructed without a dictionary

Definition at line 93 of file faPatchFieldBase.C.

References dict, keyType::LITERAL, and dictionary::readIfPresent().

Referenced by faPatchFieldBase::faPatchFieldBase().

Here is the call graph for this function:

Here is the caller graph for this function:

setUpdated()

void setUpdated ( bool  state )

inlineprotectednoexcept

Set updated state.

Definition at line 113 of file faPatchField.H.

TypeName()

TypeName

(

"faPatchField"

)

Runtime type information.

patch()

const faPatch& patch ( ) const

inlinenoexcept

The associated objectRegistry.

/ const objectRegistry& db() const;

Return the patch

Definition at line 179 of file faPatchField.H.

Referenced by faPatchField< Type >::NewCalculatedType().

Here is the caller graph for this function:

patchType() [1/2]

const word& patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 187 of file faPatchField.H.

patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 195 of file faPatchField.H.

updated()

bool updated ( ) const

inlinenoexcept

True if the boundary condition has already been updated.

Definition at line 206 of file faPatchField.H.

checkPatch()

void checkPatch

(

const faPatchFieldBase &

rhs

)

const

Check that patches are identical.

Definition at line 105 of file faPatchFieldBase.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Member Data Documentation

disallowGenericPatchField

int disallowGenericPatchField

static

Debug switch to disallow the use of generic faPatchField.

Definition at line 124 of file faPatchField.H.

---

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

• src/finiteArea/fields/faPatchFields/faPatchField/faPatchField.H
• src/finiteArea/fields/faPatchFields/faPatchField/faPatchFieldBase.C