Generic GeometricBoundaryField class. More...

#include <GeometricBoundaryField.H>

Inheritance diagram for GeometricBoundaryField< Type, PatchField, GeoMesh >:

[legend]

Collaboration diagram for GeometricBoundaryField< Type, PatchField, GeoMesh >:

Public Types
typedef GeometricBoundaryField< Type, PatchField, GeoMesh >	this_type
	The template instance used for this GeometricBoundaryField type.
typedef GeoMesh::BoundaryMesh	BoundaryMesh
	The boundary mesh type for the boundary fields.
typedef DimensionedField< Type, GeoMesh >	Internal
	The internal field type associated with the boundary fields.
typedef GeometricBoundaryField< Type, PatchField, GeoMesh >	Boundary
	This boundary field type.
typedef PatchField< Type >	Patch
	The patch field type for the boundary fields.
Public Types inherited from FieldField< PatchField, Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type.
Public Types inherited from UPtrList< PatchField< Type > >
typedef PatchField< Type >	value_type
	Type of values the list contains.
typedef PatchField< Type > &	reference
	A non-const reference to the value_type.
typedef const PatchField< Type > &	const_reference
	A const reference to the value_type.

Public Member Functions
	GeometricBoundaryField (const BoundaryMesh &bmesh)
	Construct from a BoundaryMesh, setting patches later.
	GeometricBoundaryField (const BoundaryMesh &bmesh, const Internal &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct from a BoundaryMesh, reference to the internal field and a patch type.
	GeometricBoundaryField (const BoundaryMesh &bmesh, const Internal &iField, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct from a BoundaryMesh, reference to the internal field and a wordList of patch types and optional the actual patch types (to override constraint patches).
	GeometricBoundaryField (const BoundaryMesh &bmesh, const Internal &iField, const PtrList< PatchField< Type > > &ptfl)
	Construct from a BoundaryMesh, reference to the internal field and a PtrList<PatchField<Type>> (to be cloned).
	GeometricBoundaryField (const Internal &iField, const GeometricBoundaryField< Type, PatchField, GeoMesh > &btf)
	Construct as copy, setting the reference to the internal field.
	GeometricBoundaryField (const Internal &iField, const GeometricBoundaryField< Type, PatchField, GeoMesh > &btf, const labelList &patchIDs, const word &patchFieldName)
	Construct as copy, setting the reference to the internal field and resetting type of field for given patch IDs.
	GeometricBoundaryField (const GeometricBoundaryField &btf)
	Copy construct.
	GeometricBoundaryField (const BoundaryMesh &bmesh, const Internal &iField, const dictionary &dict)
	Construct from dictionary.
this_type &	constCast () const noexcept
	Return non-const reference to this boundary field.
void	readField (const Internal &iField, const dictionary &dict)
	Read the boundary field.
void	updateCoeffs ()
	Update the boundary condition coefficients.
void	evaluate (const UPstream::commsTypes commsType=UPstream::defaultCommsType)
	Evaluate boundary conditions for each patch field. Uses specified or default comms.
template<class UnaryPredicate>
void	evaluate_if (const UnaryPredicate &pred, const UPstream::commsTypes commsType=UPstream::defaultCommsType)
	Evaluate boundary conditions for patch fields matching the given predicate. Uses specified or default comms.
void	evaluateLocal (const UPstream::commsTypes commsType=UPstream::defaultCommsType)
	Evaluate boundary conditions after change in local values. Uses specified or default comms.
template<class CoupledPatchType>
void	evaluateCoupled (const UPstream::commsTypes commsType=UPstream::defaultCommsType)
	Evaluate boundary conditions on coupled patches of the given type, using specified or default comms.
void	evaluateSelected (const labelUList &patchIDs)
	Evaluate boundary conditions for selected patches. Uses non-blocking comms.
wordList	types () const
	Return a list of the patch types.
tmp< GeometricBoundaryField >	boundaryInternalField () const
	Return boundary field of values neighbouring the boundary.
LduInterfaceFieldPtrsList< Type >	interfaces () const
	Return a list of pointers for each patch field with only those pointing to interfaces being set.
lduInterfaceFieldPtrsList	scalarInterfaces () const
	Return a list of pointers for each patch field with only those pointing to interfaces being set.
bool	check () const
	Helper: check if field has been evaluated. See instantiations.
void	writeEntry (const word &keyword, Ostream &os) const
	Write boundary field as dictionary entry.
void	writeEntries (Ostream &os) const
	Write dictionary entries of the individual boundary fields.
void	operator= (const GeometricBoundaryField &bf)
	Copy assignment from GeometricBoundaryField.
void	operator= (const FieldField< PatchField, Type > &bf)
	Copy assignment from FieldField<PatchField, Type>.
void	operator= (const Type &val)
	Assignment to uniform value.
void	operator= (Foam::zero)
	Assignment to zero.
void	operator== (const GeometricBoundaryField &bf)
	Forced assignment from GeometricBoundaryField.
void	operator== (const FieldField< PatchField, Type > &bf)
	Forced assignment from FieldField<PatchField, Type>.
void	operator== (const Type &val)
	Forced assignment to uniform value.
void	operator== (Foam::zero)
	Forced assignment to zero.
bool	operator!= (const GeometricBoundaryField &)=delete
bool	operator!= (const FieldField< PatchField, Type > &)=delete
bool	operator!= (const Type &)=delete
bool	operator!= (Foam::zero)=delete
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
bool	check () const
Public Member Functions inherited from FieldField< PatchField, Type >
constexpr	FieldField () noexcept
	Construct null.
tmp< FieldField< PatchField, Type > >	clone () const
	Clone.
void	negate ()
	Negate this field. See notes in Field.
void	normalise ()
	Normalise this field. See notes in Field.
tmp< FieldField< PatchField, cmptType > >	component (const direction) const
	Return a component field of the field.
void	replace (const direction, const FieldField< PatchField, cmptType > &)
	Replace a component field of the field.
void	clamp_min (const Type &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_max (const Type &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_range (const Type &lower, const Type &upper)
	Clamp field values (in-place) to the specified range.
tmp< FieldField< PatchField, Type > >	T () const
	Return the field transpose (only defined for second rank tensors).
const Type &	operator[] (const labelPair &index) const
	Const access to a single field element via (fieldi, elemi).
void	operator= (const FieldField< PatchField, Type > &)
	Copy assignment.
void	operator+= (const FieldField< PatchField, Type > &)
void	operator-= (const FieldField< PatchField, Type > &)
void	operator*= (const FieldField< PatchField, scalar > &)
void	operator/= (const FieldField< PatchField, scalar > &)
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.
Public Member Functions inherited from PtrList< PatchField< Type > >
Foam::PtrList< PatchField< Type > >	clone (Args &&... args) const
constexpr	PtrList () noexcept
	Default construct.
	~PtrList ()
	Destructor. Frees all pointers.
const PatchField< Type > *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero.
void	free ()
	Free memory and nullify all entries. Does not change the list size.
void	resize (const label newLen)
	Adjust size of PtrList.
void	resize_null (const label newLen)
	Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all `nullptr` entries.
PatchField< Type > &	emplace_back (Args &&... args)
	Construct and append an element to the end of the list, return reference to the new list element.
void	push_back (PatchField< Type > *ptr)
	Append an element to the end of the list.
PatchField< Type > &	emplace_set (const label i, Args &&... args)
	Construct and set a new element at given position, (discard old element at that location).
PatchField< Type > &	emplace (const label i, Args &&... args)
	Same as emplace_set().
PatchField< Type > &	try_emplace (const label i, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location.
autoPtr< PatchField< Type > >	release (const label i)
	Release ownership of the pointer at the given position.
void	transfer (PtrList< PatchField< Type > > &list)
	Transfer into this list and annul the argument list.
void	operator= (const UPtrList< PatchField< Type > > &list)
	Copy assignment.
void	setSize (const label n)
	Same as resize().
void	append (autoPtr< PatchField< Type > > &ptr)
	Move append an element to the end of the list.
Public Member Functions inherited from UPtrList< PatchField< Type > >
bool	empty () const noexcept
	True if the list is empty (ie, size() is zero).
label	size () const noexcept
	The number of entries in the list.
label	capacity () const noexcept
	Size of the underlying storage.
label	count_nonnull () const noexcept
	The number of non-nullptr entries in the list.
PatchField< Type > &	front ()
	Reference to the first element of the list.
PatchField< Type > &	back ()
	Reference to the last element of the list.
const PatchField< Type > *	test (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
const PatchField< Type > *	get (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
const PatchField< Type > *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
void	clear ()
	Set list size to zero.
void	free ()
	Nullify all entries. Does not change the list size.
void	resize (const label newLen)
	Change the size of the list. Any new entries are `nullptr`.
void	resize_null (const label newLen)
	Set the list to the given size and set all entries to `nullptr`.
label	squeezeNull ()
	Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list.
void	push_back (PatchField< Type > *ptr)
	Append an element to the end of the list.
void	swap (UPtrList< PatchField< Type > > &list) noexcept
	Swap content.
void	transfer (UPtrList< PatchField< Type > > &list)
	Transfer contents into this list and annul the argument.
void	reorder (const labelUList &oldToNew, const bool check=false)
	Reorder elements. Reordering must be unique (ie, shuffle).
void	sortOrder (const labelUList &order, const bool check=false)
	Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle).
void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list.
const PatchField< Type > &	at (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr.
const PatchField< Type > &	operator[] (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at().
	FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const PatchField< Type > *operator()(const label i) const
	Deprecated(2022-09) - same as get().
void	operator= (const UPtrList< PatchField< Type > > &list)
	Copy assignment (shallow copies addresses).
Ostream &	printAddresses (Ostream &os) const
	Print pointer addresses to Ostream (debugging only).
Ostream &	writeList (Ostream &os, const bool trimNull=false) const
	Write UPtrList to Ostream, optionally ignoring null entries.
PatchField< Type > **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution).
PatchField< Type > **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution).
iterator	begin ()
	Return iterator to begin traversal of non-nullptr entries.
iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal.
const_iterator	cbegin () const
	Return const_iterator to begin traversal of non-nullptr entries.
const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal.
void	setSize (const label n)
	Alias for resize().
PatchField< Type > &	first ()
	Reference to the first element of the list.
PatchField< Type > &	last ()
	Return reference to the last element of the list.
void	append (PatchField< Type > *ptr)
	Append an element to the end of the list.
label	count () const noexcept
	The number of non-nullptr entries in the list.

Static Public Attributes
static int	debug
	Enable debug.

Additional Inherited Members
Static Public Member Functions inherited from FieldField< PatchField, Type >
static tmp< FieldField< PatchField, Type > >	NewCalculatedType (const FieldField< PatchField, Type2 > &ff)
	Return a pointer to a new calculatedFvPatchFieldField created on.
Protected Member Functions inherited from PtrList< PatchField< Type > >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class.
Protected Member Functions inherited from UPtrList< PatchField< Type > >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size.
label	find_next (label pos) const
	The next non-null entry after the specified position.
	UPtrList (Detail::PtrListDetail< PatchField< Type > > &&ptrs) noexcept
	Low-level move construct.
Protected Attributes inherited from UPtrList< PatchField< Type > >
Detail::PtrListDetail< PatchField< Type > >	ptrs_
	The list of pointers.

Detailed Description

template<class Type, template< class > class PatchField, class GeoMesh>
class Foam::GeometricBoundaryField< Type, PatchField, GeoMesh >

Generic GeometricBoundaryField class.

Source files

Definition at line 52 of file GeometricBoundaryField.H.

Member Typedef Documentation

◆ this_type

template<class Type, template< class > class PatchField, class GeoMesh>

typedef GeometricBoundaryField<Type, PatchField, GeoMesh> this_type

The template instance used for this GeometricBoundaryField type.

Definition at line 63 of file GeometricBoundaryField.H.

◆ BoundaryMesh

template<class Type, template< class > class PatchField, class GeoMesh>

typedef GeoMesh::BoundaryMesh BoundaryMesh

The boundary mesh type for the boundary fields.

Definition at line 68 of file GeometricBoundaryField.H.

◆ Internal

template<class Type, template< class > class PatchField, class GeoMesh>

typedef DimensionedField<Type, GeoMesh> Internal

The internal field type associated with the boundary fields.

Definition at line 73 of file GeometricBoundaryField.H.

◆ Boundary

template<class Type, template< class > class PatchField, class GeoMesh>

typedef GeometricBoundaryField<Type, PatchField, GeoMesh> Boundary

This boundary field type.

Definition at line 78 of file GeometricBoundaryField.H.

◆ Patch

template<class Type, template< class > class PatchField, class GeoMesh>

typedef PatchField<Type> Patch

The patch field type for the boundary fields.

Definition at line 83 of file GeometricBoundaryField.H.

Constructor & Destructor Documentation

◆ GeometricBoundaryField() [1/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField ( const BoundaryMesh & bmesh )

explicit

Construct from a BoundaryMesh, setting patches later.

Definition at line 326 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::FieldField(), and UPtrList< PatchField< Type > >::size().

Referenced by GeometricBoundaryField(), and GeometricBoundaryField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GeometricBoundaryField() [2/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const Internal &	iField,
		const word &	patchFieldType = PatchField<Type>::calculatedType() )

Construct from a BoundaryMesh, reference to the internal field and a patch type.

Definition at line 337 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::FieldField(), forAll, PtrList< PatchField< Type > >::set(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

◆ GeometricBoundaryField() [3/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const Internal &	iField,
		const wordList &	wantedPatchTypes,
		const wordList &	actualPatchTypes = wordList() )

Construct from a BoundaryMesh, reference to the internal field and a wordList of patch types and optional the actual patch types (to override constraint patches).

Definition at line 366 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::FieldField(), if(), UList< T >::size(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

◆ GeometricBoundaryField() [4/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const Internal &	iField,
		const PtrList< PatchField< Type > > &	ptfl )

Construct from a BoundaryMesh, reference to the internal field and a PtrList<PatchField<Type>> (to be cloned).

Definition at line 430 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::clone(), FieldField< PatchField, Type >::FieldField(), forAll, PtrList< PatchField< Type > >::set(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

◆ GeometricBoundaryField() [5/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField	(	const Internal &	iField,
		const GeometricBoundaryField< Type, PatchField, GeoMesh > &	btf )

Construct as copy, setting the reference to the internal field.

Definition at line 450 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::clone(), FieldField< PatchField, Type >::FieldField(), forAll, GeometricBoundaryField(), PtrList< PatchField< Type > >::set(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

◆ GeometricBoundaryField() [6/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField	(	const Internal &	iField,
		const GeometricBoundaryField< Type, PatchField, GeoMesh > &	btf,
		const labelList &	patchIDs,
		const word &	patchFieldName )

Construct as copy, setting the reference to the internal field and resetting type of field for given patch IDs.

Definition at line 469 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::clone(), FieldField< PatchField, Type >::FieldField(), forAll, GeometricBoundaryField(), patchIDs, PtrList< PatchField< Type > >::set(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

◆ GeometricBoundaryField() [7/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField ( const GeometricBoundaryField< Type, PatchField, GeoMesh > & btf )

Copy construct.

Dangerous because Field may be set to a field which gets deleted Need new type of BoundaryField, one which is part of a geometric field for which snGrad etc. may be called and a free standing BoundaryField for which such operations are unavailable.

◆ GeometricBoundaryField() [8/8]

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const Internal &	iField,
		const dictionary &	dict )

Construct from dictionary.

Definition at line 518 of file GeometricBoundaryField.C.

References dict, FieldField< PatchField, Type >::FieldField(), readField(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

Member Function Documentation

◆ constCast()

template<class Type, template< class > class PatchField, class GeoMesh>

this_type & constCast ( ) const

inlinenoexcept

Return non-const reference to this boundary field.

Definition at line 206 of file GeometricBoundaryField.H.

◆ readField()

template<class Type, template< class > class PatchField, class GeoMesh>

void readField	(	const Internal &	iField,
		const dictionary &	dict )

Read the boundary field.

Definition at line 174 of file GeometricBoundaryField.C.

References clear(), dict, resize(), PtrList< PatchField< Type > >::set(), and UPtrList< PatchField< Type > >::size().

Referenced by GeometricBoundaryField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCoeffs()

template<class Type, template< class > class PatchField, class GeoMesh>

void updateCoeffs ( )

Update the boundary condition coefficients.

Definition at line 535 of file GeometricBoundaryField.C.

Referenced by mixtureKEpsilon< BasicTurbulenceModel >::correct().

Here is the caller graph for this function:

◆ evaluate()

template<class Type, template< class > class PatchField, class GeoMesh>

void evaluate ( const UPstream::commsTypes commsType = UPstream::defaultCommsType )

Evaluate boundary conditions for each patch field. Uses specified or default comms.

Definition at line 547 of file GeometricBoundaryField.C.

References UPstream::buffered, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, UPstream::nonBlocking, UPstream::nRequests(), UPstream::scheduled, and UPstream::waitRequests().

Referenced by Foam::correctUphiBCs(), and Foam::correctUphiBCs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluate_if()

template<class Type, template< class > class PatchField, class GeoMesh>

template<class UnaryPredicate>

void evaluate_if	(	const UnaryPredicate &	pred,
		const UPstream::commsTypes	commsType = UPstream::defaultCommsType )

Evaluate boundary conditions for patch fields matching the given predicate. Uses specified or default comms.

Definition at line 604 of file GeometricBoundaryField.C.

References UPstream::buffered, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, UPstream::nonBlocking, UPstream::nRequests(), UPstream::scheduled, and UPstream::waitRequests().

Referenced by evaluateCoupled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluateLocal()

template<class Type, template< class > class PatchField, class GeoMesh>

void evaluateLocal ( const UPstream::commsTypes commsType = UPstream::defaultCommsType )

Evaluate boundary conditions after change in local values. Uses specified or default comms.

Definition at line 704 of file GeometricBoundaryField.C.

References UPstream::buffered, Foam::exit(), Foam::FatalError, FatalErrorInFunction, FieldBase::localBoundaryConsistency(), Foam::nl, UPstream::nonBlocking, UPstream::nRequests(), UPstream::scheduled, and UPstream::waitRequests().

Here is the call graph for this function:

◆ evaluateCoupled()

template<class Type, template< class > class PatchField, class GeoMesh>

template<class CoupledPatchType>

void evaluateCoupled ( const UPstream::commsTypes commsType = UPstream::defaultCommsType )

Evaluate boundary conditions on coupled patches of the given type, using specified or default comms.

Template Parameters

CoupledPatchType The coupled patch type that should be evaluated. For a void type, all coupled patch fields will be evaluated.

Definition at line 768 of file GeometricBoundaryField.C.

References evaluate_if(), and Foam::isA().

Referenced by Foam::bound(), and mixtureKEpsilon< BasicTurbulenceModel >::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluateSelected()

template<class Type, template< class > class PatchField, class GeoMesh>

void evaluateSelected ( const labelUList & patchIDs )

Evaluate boundary conditions for selected patches. Uses non-blocking comms.

Definition at line 675 of file GeometricBoundaryField.C.

References DebugInfo, Foam::endl(), UPstream::nonBlocking, UPstream::nRequests(), patchIDs, and UPstream::waitRequests().

Here is the call graph for this function:

◆ types()

template<class Type, template< class > class PatchField, class GeoMesh>

Foam::wordList types ( ) const

Return a list of the patch types.

Definition at line 798 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::FieldField(), forAll, and UPtrList< T >::size().

Referenced by mixtureKEpsilon< BasicTurbulenceModel >::epsilonBoundaryTypes(), basicThermo::heBoundaryTypes(), psiuReactionThermo::heuBoundaryTypes(), and mixtureKEpsilon< BasicTurbulenceModel >::initMixtureFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryInternalField()

template<class Type, template< class > class PatchField, class GeoMesh>

Foam::tmp< Foam::GeometricBoundaryField< Type, PatchField, GeoMesh > > boundaryInternalField ( ) const

Return boundary field of values neighbouring the boundary.

Definition at line 815 of file GeometricBoundaryField.C.

References forAll, Foam::New(), DimensionedField< Type, GeoMesh >::null(), and FieldField< PatchField, Type >::operator[]().

Here is the call graph for this function:

◆ interfaces()

template<class Type, template< class > class PatchField, class GeoMesh>

Foam::LduInterfaceFieldPtrsList< Type > interfaces ( ) const

Return a list of pointers for each patch field with only those pointing to interfaces being set.

Definition at line 837 of file GeometricBoundaryField.C.

References forAll, Foam::isA(), UPtrList< T >::set(), and UPtrList< PatchField< Type > >::size().

Here is the call graph for this function:

◆ scalarInterfaces()

template<class Type, template< class > class PatchField, class GeoMesh>

Foam::lduInterfaceFieldPtrsList scalarInterfaces ( ) const

Return a list of pointers for each patch field with only those pointing to interfaces being set.

Definition at line 856 of file GeometricBoundaryField.C.

References forAll, Foam::isA(), UPtrList< T >::set(), and UPtrList< PatchField< Type > >::size().

Referenced by oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check() [1/21]

template<class Type, template< class > class PatchField, class GeoMesh>

bool check ( ) const

Helper: check if field has been evaluated. See instantiations.

Definition at line 905 of file GeometricBoundaryField.C.

Referenced by Foam::FieldOps::assign(), Foam::FieldOps::assign(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::pow(), Foam::pow(), Foam::T(), Foam::FieldOps::ternary(), and Foam::FieldOps::ternarySelect().

Here is the caller graph for this function:

◆ writeEntry()

template<class Type, template< class > class PatchField, class GeoMesh>

void writeEntry	(	const word &	keyword,
		Ostream &	os ) const

Write boundary field as dictionary entry.

Definition at line 875 of file GeometricBoundaryField.C.

References FUNCTION_NAME, os(), and writeEntries().

Here is the call graph for this function:

◆ writeEntries()

template<class Type, template< class > class PatchField, class GeoMesh>

void writeEntries ( Ostream & os ) const

Write dictionary entries of the individual boundary fields.

Definition at line 890 of file GeometricBoundaryField.C.

References os().

Referenced by writeEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator= ( const GeometricBoundaryField< Type, PatchField, GeoMesh > & bf )

Copy assignment from GeometricBoundaryField.

◆ operator=() [2/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator= ( const FieldField< PatchField, Type > & bf )

Copy assignment from FieldField<PatchField, Type>.

Definition at line 928 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::FieldField(), FieldField< PatchField, Type >::operator, and FieldField< Field, Type >::operator=().

Here is the call graph for this function:

◆ operator=() [3/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator= ( const Type & val )

Assignment to uniform value.

Definition at line 938 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::operator, and FieldField< Field, Type >::operator=().

Here is the call graph for this function:

◆ operator=() [4/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator= ( Foam::zero )

Assignment to zero.

Definition at line 948 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::operator, and FieldField< Field, Type >::operator=().

Here is the call graph for this function:

◆ operator==() [1/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator== ( const GeometricBoundaryField< Type, PatchField, GeoMesh > & bf )

Forced assignment from GeometricBoundaryField.

◆ operator==() [2/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator== ( const FieldField< PatchField, Type > & bf )

Forced assignment from FieldField<PatchField, Type>.

Definition at line 971 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::FieldField(), forAll, FieldField< PatchField, Type >::operator, and FieldField< PatchField, Type >::operator[]().

Here is the call graph for this function:

◆ operator==() [3/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator== ( const Type & val )

Forced assignment to uniform value.

Definition at line 984 of file GeometricBoundaryField.C.

References FieldField< PatchField, Type >::operator.

Here is the call graph for this function:

◆ operator==() [4/4]

template<class Type, template< class > class PatchField, class GeoMesh>

void operator== ( Foam::zero )

inline

Forced assignment to zero.

Definition at line 352 of file GeometricBoundaryField.H.

◆ operator!=() [1/4]

template<class Type, template< class > class PatchField, class GeoMesh>

bool operator!= ( const GeometricBoundaryField< Type, PatchField, GeoMesh > & )

delete

◆ operator!=() [2/4]

template<class Type, template< class > class PatchField, class GeoMesh>

bool operator!= ( const FieldField< PatchField, Type > & )

delete

◆ operator!=() [3/4]

template<class Type, template< class > class PatchField, class GeoMesh>

bool operator!= ( const Type & )

delete

◆ operator!=() [4/4]

template<class Type, template< class > class PatchField, class GeoMesh>

bool operator!= ( Foam::zero )

delete

◆ check() [2/21]

bool check ( ) const

Definition at line 118 of file areaFields.C.

◆ check() [3/21]

bool check ( ) const

Definition at line 119 of file areaFields.C.

◆ check() [4/21]

bool check ( ) const

Definition at line 120 of file areaFields.C.

◆ check() [5/21]

bool check ( ) const

Definition at line 121 of file areaFields.C.

◆ check() [6/21]

bool check ( ) const

Definition at line 122 of file areaFields.C.

◆ check() [7/21]

bool check ( ) const

◆ check() [8/21]

bool check ( ) const

◆ check() [9/21]

bool check ( ) const

◆ check() [10/21]

bool check ( ) const

◆ check() [11/21]

bool check ( ) const

◆ check() [12/21]

bool check ( ) const

Definition at line 118 of file volFields.C.

◆ check() [13/21]

bool check ( ) const

Definition at line 119 of file volFields.C.

◆ check() [14/21]

bool check ( ) const

Definition at line 120 of file volFields.C.

◆ check() [15/21]

bool check ( ) const

Definition at line 121 of file volFields.C.

◆ check() [16/21]

bool check ( ) const

Definition at line 122 of file volFields.C.

◆ check() [17/21]

bool check ( ) const

◆ check() [18/21]

bool check ( ) const

◆ check() [19/21]

bool check ( ) const

◆ check() [20/21]

bool check ( ) const

◆ check() [21/21]

bool check ( ) const

Member Data Documentation

◆ debug

template<class Type, template< class > class PatchField, class GeoMesh>

int debug

static

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

src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricBoundaryField.H
src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricBoundaryField.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ this_type

◆ BoundaryMesh

◆ Internal

◆ Boundary

◆ Patch

Constructor & Destructor Documentation

◆ GeometricBoundaryField() [1/8]

◆ GeometricBoundaryField() [2/8]

◆ GeometricBoundaryField() [3/8]

◆ GeometricBoundaryField() [4/8]

◆ GeometricBoundaryField() [5/8]

◆ GeometricBoundaryField() [6/8]

◆ GeometricBoundaryField() [7/8]

◆ GeometricBoundaryField() [8/8]

Member Function Documentation

◆ constCast()

◆ readField()

◆ updateCoeffs()

◆ evaluate()

◆ evaluate_if()

◆ evaluateLocal()

◆ evaluateCoupled()

◆ evaluateSelected()

◆ types()

◆ boundaryInternalField()

◆ interfaces()

◆ scalarInterfaces()

◆ check() [1/21]

◆ writeEntry()

◆ writeEntries()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]

◆ check() [2/21]

◆ check() [3/21]

◆ check() [4/21]

◆ check() [5/21]

◆ check() [6/21]

◆ check() [7/21]

◆ check() [8/21]

◆ check() [9/21]

◆ check() [10/21]

◆ check() [11/21]

◆ check() [12/21]

◆ check() [13/21]

◆ check() [14/21]

◆ check() [15/21]

◆ check() [16/21]

◆ check() [17/21]

◆ check() [18/21]

◆ check() [19/21]

◆ check() [20/21]

◆ check() [21/21]

Member Data Documentation

◆ debug