Generic GeometricBoundaryField class. More...

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

[legend]

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

Public Types
typedef GeoMesh::BoundaryMesh	BoundaryMesh
	The boundary mesh type for the boundary fields. More...

typedef DimensionedField< Type, GeoMesh >	Internal
	The internal field type associated with the boundary fields. More...

typedef PatchField< Type >	Patch
	The patch field type for the boundary fields. More...

Public Types inherited from FieldField< PatchField, Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the list contains. More...

typedef T &	reference
	A non-const reference to the value_type. More...

typedef const T &	const_reference
	A const reference to the value_type. More...

Public Member Functions
	GeometricBoundaryField (const BoundaryMesh &bmesh)
	Construct from a BoundaryMesh, setting patches later. More...

	GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct from a BoundaryMesh, reference to the internal field and a patch type. More...

	GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, 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) More...

	GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const PtrList< PatchField< Type >> &ptfl)
	Construct from a BoundaryMesh, reference to the internal field and a PtrList<PatchField<Type>> (to be cloned) More...

	GeometricBoundaryField (const DimensionedField< Type, GeoMesh > &field, const GeometricBoundaryField< Type, PatchField, GeoMesh > &btf)
	Construct as copy, setting the reference to the internal field. More...

	GeometricBoundaryField (const DimensionedField< Type, GeoMesh > &field, 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. More...

	GeometricBoundaryField (const GeometricBoundaryField &btf)
	Copy construct. More...

	GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const dictionary &dict)
	Construct from dictionary. More...

void	readField (const DimensionedField< Type, GeoMesh > &field, const dictionary &dict)
	Read the boundary field. More...

void	updateCoeffs ()
	Update the boundary condition coefficients. More...

void	evaluate ()
	Evaluate boundary conditions. More...

void	evaluateLocal ()
	Evaluate boundary conditions after change in local values. More...

template<class CoupledPatchType >
void	evaluateCoupled ()
	Evaluate boundary conditions on a subset of coupled patches. More...

void	evaluateSelected (const UList< label > &patchIDs)
	Evaluate boundary conditions for selected patches. More...

wordList	types () const
	Return a list of the patch types. More...

GeometricBoundaryField	boundaryInternalField () const
	Return boundary field of values neighbouring the boundary. More...

LduInterfaceFieldPtrsList< Type >	interfaces () const
	Return a list of pointers for each patch field with only those pointing to interfaces being set. More...

lduInterfaceFieldPtrsList	scalarInterfaces () const
	Return a list of pointers for each patch field with only those pointing to interfaces being set. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write boundary field as dictionary entry. More...

void	writeEntries (Ostream &os) const
	Write dictionary entries of the individual boundary fields. More...

bool	check () const
	Helper: check if field has been evaluated. See instantiations. More...

void	operator= (const GeometricBoundaryField &bf)
	Copy assignment from GeometricBoundaryField. More...

void	operator= (const FieldField< PatchField, Type > &bf)
	Copy assignment from FieldField<PatchField, Type> More...

void	operator= (const Type &val)
	Assignment to uniform value. More...

void	operator== (const GeometricBoundaryField &bf)
	Forced assignment from GeometricBoundaryField. More...

void	operator== (const FieldField< PatchField, Type > &bf)
	Forced assignment from FieldField<PatchField, Type> More...

void	operator== (const Type &val)
	Forced assignment to uniform value. More...

bool	operator!= (const GeometricBoundaryField &)=delete

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

bool	operator!= (const Type &)=delete

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

template<>
bool	check () const

Public Member Functions inherited from FieldField< PatchField, Type >
constexpr	FieldField () noexcept
	Construct null. More...

	FieldField (const label size)
	Construct given size. More...

	FieldField (const word &type, const FieldField< PatchField, Type > &ff)
	Clone construct with new type. More...

	FieldField (const FieldField< PatchField, Type > &ff)
	Copy construct, cloning each element. More...

	FieldField (FieldField< PatchField, Type > &&ff)
	Move construct. More...

	FieldField (FieldField< PatchField, Type > &ff, bool reuse)
	Construct as copy or re-use as specified. More...

	FieldField (const PtrList< PatchField< Type >> &list)
	Copy construct from PtrList. More...

	FieldField (PtrList< PatchField< Type >> &&list)
	Move construct from PtrList. More...

	FieldField (const tmp< FieldField< PatchField, Type >> &tf)
	Move/copy construct from tmp<FieldField> More...

	FieldField (Istream &is)
	Construct from Istream. More...

tmp< FieldField< PatchField, Type > >	clone () const
	Clone. More...

void	negate ()
	Negate this field. See notes in Field. More...

void	normalise ()
	Normalise this field. See notes in Field. More...

tmp< FieldField< PatchField, cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const FieldField< PatchField, cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

void	clamp_min (const Type &lower)
	Impose lower (floor) clamp on the field values (in-place) More...

void	clamp_max (const Type &upper)
	Impose upper (ceiling) clamp on the field values (in-place) More...

void	clamp_range (const Type &lower, const Type &upper)
	Clamp field values (in-place) to the specified range. More...

void	clamp_range (const MinMax< Type > &range)
	Clamp field values (in-place) to the specified range. More...

tmp< FieldField< PatchField, Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

const Type &	operator[] (const labelPair &index) const
	Const access to a single field element via (fieldi, elemi) More...

Type &	operator[] (const labelPair &index)
	Non-const access to a single field element via (fieldi, elemi) More...

void	operator= (const FieldField< PatchField, Type > &)
	Copy assignment. More...

void	operator= (FieldField< PatchField, Type > &&)
	Move assignment. More...

void	operator= (const tmp< FieldField< PatchField, Type >> &)
	Move or clone assignment. More...

void	operator= (const Type &val)
	Assign uniform value. More...

void	operator= (const Foam::zero)
	Assign uniform zero. More...

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

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

void	operator+= (const Type &)

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

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

void	operator-= (const Type &)

void	operator*= (const FieldField< PatchField, scalar > &)

void	operator*= (const tmp< FieldField< PatchField, scalar >> &)

void	operator*= (const scalar &)

void	operator/= (const FieldField< PatchField, scalar > &)

void	operator/= (const tmp< FieldField< PatchField, scalar >> &)

void	operator/= (const scalar &)

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

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

Public Member Functions inherited from PtrList< PatchField< Type > >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< PatchField< Type > > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< PatchField< Type > > &&list) noexcept
	Move construct. More...

	PtrList (UList< PatchField< Type > * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< PatchField< Type > > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< PatchField< Type > > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< PatchField< Type > > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &is)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. Frees all pointers. More...

PtrList< PatchField< Type > >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< PatchField< Type > >	clone (Args &&... args) const

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

autoPtr< PatchField< Type > >	set (const label i, PatchField< Type > *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< PatchField< Type > >	set (const label i, std::unique_ptr< PatchField< Type > > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< PatchField< Type > >	set (const label i, autoPtr< PatchField< Type > > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< PatchField< Type > >	set (const label i, const refPtr< PatchField< Type > > &ptr)
	Set element to given refPtr and return old element. More...

autoPtr< PatchField< Type > >	set (const label i, const tmp< PatchField< Type > > &ptr)
	Set element to given tmp and return old element. More...

autoPtr< PatchField< Type > >	set (const label i, autoPtr< PatchField< Type > > &ptr)
	Set element to given autoPtr and return old element. More...

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	free ()
	Free memory and nullify all entries. Does not change the list size. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

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

PatchField< Type > &	emplace_back (Args &&... args)
	Construct and append an element to the end of the list, return reference to the new list element. More...

void	push_back (PatchField< Type > *ptr)
	Append an element to the end of the list. More...

void	push_back (std::unique_ptr< PatchField< Type > > &&ptr)
	Move append an element to the end of the list. More...

void	push_back (autoPtr< PatchField< Type > > &&ptr)
	Move append an element to the end of the list. More...

void	push_back (const refPtr< PatchField< Type > > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	push_back (const tmp< PatchField< Type > > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	push_back (PtrList< PatchField< Type > > &&other)
	Move append another list to the end of this list. More...

void	push_back (autoPtr< PatchField< Type > > &ptr)=delete
	Disallow push_back with autoPtr without std::move. More...

PatchField< Type > &	emplace_set (const label i, Args &&... args)
	Construct and set a new element at given position, (discard old element at that location). More...

PatchField< Type > &	emplace (const label i, Args &&... args)
	Same as emplace_set() More...

PatchField< Type > &	try_emplace (const label i, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location. More...

autoPtr< PatchField< Type > >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< PatchField< Type > > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< PatchField< Type > > &list)
	Copy assignment. More...

void	operator= (PtrList< PatchField< Type > > &&list)
	Move assignment. More...

void	setSize (const label newLen)
	Same as resize() More...

void	append (autoPtr< PatchField< Type > > &ptr)
	Move append an element to the end of the list. More...

void	append (PatchField< Type > *ptr)
	Append an element to the end of the list. More...

void	append (std::unique_ptr< PatchField< Type > > &&ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< PatchField< Type > > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< PatchField< Type > > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	append (const tmp< PatchField< Type > > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	append (PtrList< PatchField< Type > > &&other)
	Move append another list to the end of this list. More...

Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept=default
	Default construct. More...

	UPtrList (const label len)
	Construct with specified size and set all entries to `nullptr`. More...

	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses) More...

	UPtrList (UPtrList< T > &&list) noexcept
	Move construct. More...

	UPtrList (UPtrList< T > &list, bool reuse)
	Construct as shallow copy or re-use as specified. More...

	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList. More...

	UPtrList (const UList< T *> &list)
	Construct from UList of pointers (shallow copy) More...

	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element. More...

bool	empty () const noexcept
	True if the list is empty (ie, size() is zero) More...

label	size () const noexcept
	The number of entries in the list. More...

label	capacity () const noexcept
	Size of the underlying storage. More...

label	count () const noexcept
	The number of non-null entries in the list. More...

T &	front ()
	Reference to the first element of the list. More...

const T &	front () const
	Reference to first element of the list. More...

T &	back ()
	Reference to the last element of the list. More...

const T &	back () const
	Reference to the last element of the list. More...

const T *	test (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

const T *	get (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

T *	get (const label i)
	Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

const T *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

void	clear ()
	Set list size to zero. More...

void	free ()
	Nullify all entries. Does not change the list size. More...

void	resize (const label newLen)
	Change the size of the list. Any new entries are `nullptr`. More...

void	resize_null (const label newLen)
	Set the list to the given size and set all entries to `nullptr`. More...

label	squeezeNull ()
	Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More...

void	trimTrailingNull ()
	Reduce addressable list size to ignore any trailing null pointers. More...

void	push_back (T *ptr)
	Append an element to the end of the list. More...

void	push_back (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

void	swap (UPtrList< T > &list) noexcept
	Swap content. More...

void	transfer (UPtrList< T > &list)
	Transfer contents into this list and annul the argument. More...

T *	set (const label i, T *ptr)
	Set element to specified pointer and return the old list element, which can be a nullptr. More...

void	reorder (const labelUList &oldToNew, const bool check=false)
	Reorder elements. Reordering must be unique (ie, shuffle). More...

void	sortOrder (const labelUList &order, const bool check=false)
	Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More...

void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list. More...

const T &	at (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. More...

T &	at (const label i)
	Return reference to the element at given position. FatalError for bounds problem or nullptr. More...

const T &	operator[] (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...

T &	operator[] (const label i)
	Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...

	FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const
	Deprecated(2022-09) - same as get() More...

void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (UPtrList< T > &&list)
	Move assignment. More...

T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution) More...

T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution) More...

iterator	begin ()
	Return iterator to begin traversal of non-nullptr entries. More...

iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversal of non-nullptr entries. More...

const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

const_iterator	begin () const
	Return const_iterator to begin traversal of non-nullptr entries. More...

const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

void	setSize (const label n)
	Alias for resize() More...

T &	first ()
	Reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	append (T *ptr)
	Append an element to the end of the list. More...

void	append (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

Static Public Attributes
static int	debug
	Enable debug. More...

static scalar	tolerance
	User-defined tolerance (for consistency checks) More...

static int	localConsistency
	Enable local consistency. More...

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

Protected Member Functions inherited from PtrList< PatchField< Type > >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

Protected Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size. More...

label	find_next (label pos) const
	The next non-null entry after the specified position. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept
	Low-level move construct. More...

Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers. More...

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 46 of file areaFieldsFwd.H.

Member Typedef Documentation

◆ BoundaryMesh

typedef GeoMesh::BoundaryMesh BoundaryMesh

The boundary mesh type for the boundary fields.

Definition at line 69 of file GeometricBoundaryField.H.

◆ Internal

typedef DimensionedField<Type, GeoMesh> Internal

The internal field type associated with the boundary fields.

Definition at line 74 of file GeometricBoundaryField.H.

◆ Patch

typedef PatchField<Type> Patch

The patch field type for the boundary fields.

Definition at line 79 of file GeometricBoundaryField.H.

Constructor & Destructor Documentation

◆ GeometricBoundaryField() [1/8]

GeometricBoundaryField ( const BoundaryMesh & bmesh )

explicit

Construct from a BoundaryMesh, setting patches later.

Definition at line 336 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [2/8]

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const DimensionedField< Type, GeoMesh > &	field,
		const word &	patchFieldType = `PatchField<Type>::calculatedType()`
	)

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

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 347 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [3/8]

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const DimensionedField< Type, GeoMesh > &	field,
		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)

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 379 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [4/8]

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const DimensionedField< Type, GeoMesh > &	field,
		const PtrList< PatchField< Type >> &	ptfl
	)

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

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 446 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [5/8]

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

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

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 469 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [6/8]

GeometricBoundaryField	(	const DimensionedField< Type, GeoMesh > &	field,
		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.

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 491 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [7/8]

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]

GeometricBoundaryField	(	const BoundaryMesh &	bmesh,
		const DimensionedField< Type, GeoMesh > &	field,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 548 of file GeometricBoundaryField.C.

Member Function Documentation

◆ readField()

void readField	(	const DimensionedField< Type, GeoMesh > &	field,
		const dictionary &	dict
	)

Read the boundary field.

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 184 of file GeometricBoundaryField.C.

◆ updateCoeffs()

void updateCoeffs ( )

Update the boundary condition coefficients.

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 564 of file GeometricBoundaryField.C.

Referenced by ShihQuadraticKE::correct(), LamBremhorstKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), and pLaplacianMotionSolver::setBoundaryConditions().

Here is the caller graph for this function:

◆ evaluate()

void evaluate ( )

Evaluate boundary conditions.

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 579 of file GeometricBoundaryField.C.

Referenced by motionSmootherAlgo::correctBoundaryConditions(), Foam::correctUphiBCs(), and motionSmootherAlgo::setDisplacementPatchFields().

Here is the caller graph for this function:

◆ evaluateLocal()

void evaluateLocal ( )

Evaluate boundary conditions after change in local values.

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 665 of file GeometricBoundaryField.C.

◆ evaluateCoupled()

void evaluateCoupled ( )

Evaluate boundary conditions on a subset of coupled patches.

if (GeometricField<Type, PatchField, GeoMesh::debug) { InfoInFunction << nl; }

Definition at line 736 of file GeometricBoundaryField.C.

Referenced by Foam::bound(), ShihQuadraticKE::correct(), LamBremhorstKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), and kkLOmega::correct().

Here is the caller graph for this function:

◆ evaluateSelected()

void evaluateSelected ( const UList< label > & patchIDs )

Evaluate boundary conditions for selected patches.

Definition at line 643 of file GeometricBoundaryField.C.

◆ types()

Foam::wordList types ( ) const

Return a list of the patch types.

Definition at line 815 of file GeometricBoundaryField.C.

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

Here is the caller graph for this function:

◆ boundaryInternalField()

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

Return boundary field of values neighbouring the boundary.

Definition at line 833 of file GeometricBoundaryField.C.

◆ interfaces()

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 848 of file GeometricBoundaryField.C.

◆ scalarInterfaces()

Foam::lduInterfaceFieldPtrsList scalarInterfaces ( ) const

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

Definition at line 870 of file GeometricBoundaryField.C.

Referenced by faMatrix< Type >::residual(), and fvMatrix< Type >::residual().

Here is the caller graph for this function:

◆ writeEntry()

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

Write boundary field as dictionary entry.

Definition at line 891 of file GeometricBoundaryField.C.

◆ writeEntries()

void writeEntries ( Ostream & os ) const

Write dictionary entries of the individual boundary fields.

Definition at line 906 of file GeometricBoundaryField.C.

◆ check() [1/21]

bool check ( ) const

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

Definition at line 921 of file GeometricBoundaryField.C.

◆ operator=() [1/3]

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

Copy assignment from GeometricBoundaryField.

◆ operator=() [2/3]

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

Copy assignment from FieldField<PatchField, Type>

Definition at line 944 of file GeometricBoundaryField.C.

◆ operator=() [3/3]

void operator= ( const Type & val )

Assignment to uniform value.

Definition at line 954 of file GeometricBoundaryField.C.

◆ operator==() [1/3]

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

Forced assignment from GeometricBoundaryField.

◆ operator==() [2/3]

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

Forced assignment from FieldField<PatchField, Type>

Definition at line 977 of file GeometricBoundaryField.C.

◆ operator==() [3/3]

void operator== ( const Type & val )

Forced assignment to uniform value.

Definition at line 990 of file GeometricBoundaryField.C.

◆ operator!=() [1/3]

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

delete

◆ operator!=() [2/3]

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

delete

◆ operator!=() [3/3]

bool operator!= ( const Type & )

delete

◆ check() [2/21]

bool check ( ) const

Definition at line 227 of file areaFields.C.

◆ check() [3/21]

bool check ( ) const

Definition at line 237 of file areaFields.C.

◆ check() [4/21]

bool check ( ) const

Definition at line 248 of file areaFields.C.

◆ check() [5/21]

bool check ( ) const

Definition at line 258 of file areaFields.C.

◆ check() [6/21]

bool check ( ) const

Definition at line 268 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 232 of file volFields.C.

◆ check() [13/21]

bool check ( ) const

Definition at line 242 of file volFields.C.

◆ check() [14/21]

bool check ( ) const

Definition at line 253 of file volFields.C.

◆ check() [15/21]

bool check ( ) const

Definition at line 264 of file volFields.C.

◆ check() [16/21]

bool check ( ) const

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

int debug

static

Enable debug.

Definition at line 109 of file GeometricBoundaryField.H.

◆ tolerance

scalar tolerance

static

User-defined tolerance (for consistency checks)

Definition at line 114 of file GeometricBoundaryField.H.

◆ localConsistency

int localConsistency

static

Enable local consistency.

Definition at line 119 of file GeometricBoundaryField.H.

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

src/finiteArea/fields/areaFields/areaFieldsFwd.H
src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricBoundaryField.H
src/finiteArea/fields/areaFields/areaFields.C
src/finiteArea/fields/edgeFields/edgeFields.C
src/finiteVolume/fields/surfaceFields/surfaceFields.C
src/finiteVolume/fields/volFields/volFields.C
src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricBoundaryField.C
src/OpenFOAM/fields/GeometricFields/pointFields/pointFields.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ BoundaryMesh

◆ Internal

◆ 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

◆ readField()

◆ updateCoeffs()

◆ evaluate()

◆ evaluateLocal()

◆ evaluateCoupled()

◆ evaluateSelected()

◆ types()

◆ boundaryInternalField()

◆ interfaces()

◆ scalarInterfaces()

◆ writeEntry()

◆ writeEntries()

◆ check() [1/21]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ 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

◆ tolerance

◆ localConsistency

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