Generic GeometricBoundaryField class. More...

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

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

Public Types
typedef GeoMesh::BoundaryMesh	BoundaryMesh
	Type of boundary mesh on which this boundary is instantiated. More...

typedef DimensionedField< Type, GeoMesh >	Internal
	Type of the internal field from which this GeometricField is derived. 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 UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Public Member Functions
	GeometricBoundaryField (const BoundaryMesh &)
	Construct from a BoundaryMesh. More...

	GeometricBoundaryField (const BoundaryMesh &, const Internal &, const word &)
	Construct from a BoundaryMesh,. More...

	GeometricBoundaryField (const BoundaryMesh &, const Internal &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct from a BoundaryMesh,. More...

	GeometricBoundaryField (const BoundaryMesh &, const Internal &, const PtrList< PatchField< Type >> &)
	Construct from a BoundaryMesh,. More...

	GeometricBoundaryField (const Internal &, const GeometricBoundaryField &)
	Construct as copy setting the reference to the internal field. More...

	GeometricBoundaryField (const GeometricBoundaryField &)=delete
	Copy constructor deleted. More...

	GeometricBoundaryField (GeometricBoundaryField &&)=delete
	Move constructor deleted. More...

	GeometricBoundaryField (const BoundaryMesh &, const Internal &, const dictionary &)
	Construct from dictionary. More...

void	readField (const Internal &field, const dictionary &dict)
	Read the boundary field. More...

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

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

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

tmp< GeometricBoundaryField >	boundaryInternalField () const
	Return BoundaryField of the cell values neighbouring. More...

tmp< GeometricBoundaryField >	boundaryNeighbourField () const
	Return BoundaryField of the values on the other side of couples. More...

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

lduInterfaceFieldPtrsList	scalarInterfaces () const
	Return a list of pointers for each patch field with only those. More...

void	reset (const GeometricBoundaryField< Type, PatchField, GeoMesh > &)
	Reset the boundary field contents to the given field. More...

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

void	operator= (const GeometricBoundaryField &)
	Assignment operator. More...

void	operator= (GeometricBoundaryField &&)
	Move assignment operator. More...

void	operator= (const FieldField< PatchField, Type > &)
	Assignment to FieldField<PatchField, Type> More...

template<template< class > class OtherPatchField>
void	operator= (const FieldField< OtherPatchField, Type > &)
	Assignment to FieldField<OtherPatchField, Type> More...

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

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

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

template<template< class > class OtherPatchField>
void	operator== (const FieldField< OtherPatchField, Type > &)
	Forced assignment to FieldField<OtherPatchField, Type> More...

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

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

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

	FieldField (const word &, const FieldField< PatchField, Type > &)
	Construct using the Field sizes from the given FieldField. More...

	FieldField (const FieldField< PatchField, Type > &)
	Copy constructor. More...

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

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

	FieldField (const PtrList< PatchField< Type >> &)
	Construct as copy of a PtrList<Field, Type> More...

	FieldField (const tmp< FieldField< PatchField, Type >> &)
	Construct as copy of tmp<FieldField> More...

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

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

void	negate ()
	Negate this 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...

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

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

void	operator= (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, 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
int	count () const
	Return the current reference count. More...

bool	unique () const
	Return true if the reference count is zero. More...

void	operator++ ()
	Increment the reference count. More...

void	operator++ (int)
	Increment the reference count. More...

void	operator-- ()
	Decrement the reference count. More...

void	operator-- (int)
	Decrement the reference count. More...

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Public Member Functions inherited from PtrList< T >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< T > &)
	Copy constructor. More...

template<class CloneArg >
	PtrList (const PtrList< T > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (PtrList< T > &&)
	Move constructor. More...

	PtrList (PtrList< T > &, bool reuse)
	Construct as copy or reuse as specified. More...

	PtrList (const SLPtrList< T > &)
	Construct as copy of SLPtrList<T> More...

template<class INew >
	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

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

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

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

void	shrink ()
	Shrink the allocated space to the number of elements used. More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

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

void	append (const autoPtr< T > &)
	Append an element at the end of the list. More...

void	append (const tmp< T > &)
	Append an element at the end of the list. More...

void	transfer (PtrList< T > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

bool	set (const label) const
	Is element set. More...

autoPtr< T >	set (const label, T *)
	Set element to given T* and return old element (can be nullptr) More...

autoPtr< T >	set (const label, const autoPtr< T > &)
	Set element to given autoPtr<T> and return old element. More...

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

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< T > &)
	Assignment operator. More...

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

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or reuse as specified. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

T &	first ()
	Return 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	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

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

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

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be nullptr). More...

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

template<class T2 >
UPtrList< T2 >	convert ()
	Convert to list of different pointer type. More...

template<class T2 >
UPtrList< const T2 >	convert () const
	Convert to list of different pointer type. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

T *	operator() (const label)
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

template<class T2 >
Foam::UPtrList< T2 >	convert ()

template<class T2 >
Foam::UPtrList< const T2 >	convert () const

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 refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Member Functions inherited from PtrList< T >
template<class INew >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. 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 58 of file GeometricBoundaryField.H.

Member Typedef Documentation

◆ BoundaryMesh

typedef GeoMesh::BoundaryMesh BoundaryMesh

Type of boundary mesh on which this boundary is instantiated.

Definition at line 67 of file GeometricBoundaryField.H.

◆ Internal

typedef DimensionedField<Type, GeoMesh> Internal

Type of the internal field from which this GeometricField is derived.

Definition at line 70 of file GeometricBoundaryField.H.

Constructor & Destructor Documentation

◆ GeometricBoundaryField() [1/8]

GeometricBoundaryField ( const BoundaryMesh & bmesh )

Construct from a BoundaryMesh.

Definition at line 169 of file GeometricBoundaryField.C.

◆ GeometricBoundaryField() [2/8]

GeometricBoundaryField	(	const BoundaryMesh &	,
		const Internal &	,
		const word &
	)

Construct from a BoundaryMesh,.

reference to the internal field and a patch field type

◆ GeometricBoundaryField() [3/8]

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

Construct from a BoundaryMesh,.

reference to the internal field and a wordList of patch field types and optionally the actual patch types (to override constraint patches)

◆ GeometricBoundaryField() [4/8]

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

Construct from a BoundaryMesh,.

reference to the internal field and a PtrList<PatchField<Type>>

◆ GeometricBoundaryField() [5/8]

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

Construct as copy setting the reference to the internal field.

◆ GeometricBoundaryField() [6/8]

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

delete

Copy constructor deleted.

as it would not set the internalField reference correctly

◆ GeometricBoundaryField() [7/8]

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

delete

Move constructor deleted.

as it would not set the internalField reference correctly

◆ GeometricBoundaryField() [8/8]

GeometricBoundaryField	(	const BoundaryMesh &	,
		const Internal &	,
		const dictionary &
	)

Construct from dictionary.

Member Function Documentation

◆ readField()

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

Read the boundary field.

Definition at line 35 of file GeometricBoundaryField.C.

References clear(), dict, Foam::endl(), forAll, forAllConstIter, InfoInFunction, patchi, UPtrList< T >::set(), and setSize().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs

Update the boundary condition coefficients.

Definition at line 341 of file GeometricBoundaryField.C.

References Foam::endl(), forAll, InfoInFunction, and patchi.

Referenced by PDRkEpsilon::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), fvMatrix< Type >::fvMatrix(), and makeMomentumTransportModelTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluate()

void evaluate

Evaluate boundary conditions.

Definition at line 356 of file GeometricBoundaryField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, InfoInFunction, and patchi.

Referenced by motionSmootherAlgo::correctBoundaryConditions(), phaseSystem::correctPhi(), Foam::correctUphiBCs(), motionSmootherAlgo::setDisplacementPatchFields(), and fvMesh::unconform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ types()

Foam::wordList types

Return a list of the patch field types.

Definition at line 422 of file GeometricBoundaryField.C.

References forAll, patchi, and UPtrList< T >::size().

Referenced by basicThermo::heBoundaryTypes(), and psiuMulticomponentThermo::heuBoundaryTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryInternalField()

Foam::tmp< Foam::GeometricBoundaryField< Type, PatchField, GeoMesh > > boundaryInternalField

Return BoundaryField of the cell values neighbouring.

the boundary

Definition at line 439 of file GeometricBoundaryField.C.

References forAll, patchi, and tmp< T >::ref().

Here is the call graph for this function:

◆ boundaryNeighbourField()

Foam::tmp< Foam::GeometricBoundaryField< Type, PatchField, GeoMesh > > boundaryNeighbourField

Return BoundaryField of the values on the other side of couples.

Definition at line 464 of file GeometricBoundaryField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, patchi, and tmp< T >::ref().

Referenced by volPointInterpolation::interpolateUnconstrained(), Foam::MULES::limiter(), and Foam::MULES::limiterCorr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interfaces()

Foam::LduInterfaceFieldPtrsList< Type > interfaces

Return a list of pointers for each patch field with only those.

pointing to interfaces being set

Definition at line 552 of file GeometricBoundaryField.C.

References forAll, Foam::isA(), patchi, Foam::refCast(), and UPtrList< T >::set().

Here is the call graph for this function:

◆ scalarInterfaces()

Foam::lduInterfaceFieldPtrsList scalarInterfaces

Return a list of pointers for each patch field with only those.

pointing to interfaces being set

Definition at line 577 of file GeometricBoundaryField.C.

References forAll, patchi, and UPtrList< T >::set().

Here is the call graph for this function:

◆ reset()

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

Reset the boundary field contents to the given field.

Used for mesh to mesh mapping

Definition at line 602 of file GeometricBoundaryField.C.

References polyMesh::boundaryMesh(), Foam::clone(), forAll, polyBoundaryMesh::mesh(), patchi, setSize(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ writeEntry()

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

Write boundary field as dictionary entry.

Definition at line 638 of file GeometricBoundaryField.C.

References IOstream::check(), Foam::decrIndent(), Foam::endl(), forAll, Foam::incrIndent(), Foam::indent(), IOstream::name(), Foam::nl, and patchi.

Referenced by GeometricField< Type, PatchField, GeoMesh >::operator/=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/5]

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

Assignment operator.

◆ operator=() [2/5]

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

Move assignment operator.

◆ operator=() [3/5]

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

Assignment to FieldField<PatchField, Type>

Definition at line 688 of file GeometricBoundaryField.C.

◆ operator=() [4/5]

void operator= ( const FieldField< OtherPatchField, Type > & ptff )

Assignment to FieldField<OtherPatchField, Type>

Definition at line 699 of file GeometricBoundaryField.C.

◆ operator=() [5/5]

void operator= ( const Type & t )

Assignment to Type.

Definition at line 709 of file GeometricBoundaryField.C.

◆ operator==() [1/4]

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

Forced assignment to.

BoundaryField<Type, PatchField, BoundaryMesh>

◆ operator==() [2/4]

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

Forced assignment to FieldField<PatchField, Type>

Definition at line 733 of file GeometricBoundaryField.C.

References forAll, and patchi.

◆ operator==() [3/4]

void operator== ( const FieldField< OtherPatchField, Type > & ptff )

Forced assignment to FieldField<OtherPatchField, Type>

Definition at line 748 of file GeometricBoundaryField.C.

References forAll, and patchi.

◆ operator==() [4/4]

void operator== ( const Type & t )

Forced assignment to Type.

Definition at line 762 of file GeometricBoundaryField.C.

References forAll, and patchi.

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

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

Public Types

Public Member Functions

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

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()

◆ types()

◆ boundaryInternalField()

◆ boundaryNeighbourField()

◆ interfaces()

◆ scalarInterfaces()

◆ reset()

◆ writeEntry()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

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