Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >::Boundary:

Collaboration diagram for GeometricField< Type, PatchField, GeoMesh >::Boundary:

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

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

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

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

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

	Boundary (const Boundary &)
	Construct as copy. More...

	Boundary (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 types. More...

Boundary	boundaryInternalField () const
	Return BoundaryField of the cell values neighbouring. 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	writeEntry (const word &keyword, Ostream &os) const
	Write boundary field as dictionary entry. More...

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

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

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

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

void	operator== (const FieldField< PatchField, Type > &)
	Forced assignment to FieldField<PatchField, 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 > &)
	Construct as copy. More...

	FieldField (FieldField< PatchField, Type > &, bool reuse)
	Construct as copy or re-use 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= (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...

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

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

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

	PtrList (const PtrList< PatchField< Type > > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (const Xfer< PtrList< PatchField< Type > >> &)
	Construct by transferring the parameter contents. More...

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

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

	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	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

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

void	append (const autoPtr< PatchField< Type > > &)

void	append (const tmp< PatchField< Type > > &)

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

Xfer< PtrList< PatchField< Type > > >	xfer ()
	Transfer contents to the Xfer container. More...

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

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

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

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

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

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

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

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

	UPtrList (const Xfer< UPtrList< T >> &)
	Construct by transferring the parameter contents. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or re-use 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	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

Xfer< UPtrList< T > >	xfer ()
	Transfer contents to the Xfer container. 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 &)
	Reorders elements. Ordering does not have to be done in. 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...

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

Additional Inherited Members
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...

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 initializing count to 0. More...

Protected Member Functions inherited from PtrList< PatchField< Type > >
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::GeometricField< Type, PatchField, GeoMesh >::Boundary

Definition at line 112 of file GeometricField.H.

Constructor & Destructor Documentation

◆ Boundary() [1/7]

Boundary ( const BoundaryMesh & bmesh )

Construct from a BoundaryMesh.

Definition at line 204 of file GeometricBoundaryField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::clone(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, InfoInFunction, Foam::New(), Foam::nl, patchi, List< T >::size(), List< Type >::size(), and GeometricField< Type, PatchField, GeoMesh >::Boundary::updateCoeffs().

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::readField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Boundary() [2/7]

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

Construct from a BoundaryMesh,.

reference to the internal field and a patch type

◆ Boundary() [3/7]

Boundary	(	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 types and optional the actual patch types (to override constraint patches)

◆ Boundary() [4/7]

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

Construct from a BoundaryMesh,.

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

◆ Boundary() [5/7]

Boundary	(	const Internal &	,
		const Boundary &
	)

Construct as copy setting the reference to the internal field.

◆ Boundary() [6/7]

Boundary ( const Boundary & )

Construct as copy.

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.

◆ Boundary() [7/7]

Boundary	(	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 34 of file GeometricBoundaryField.C.

References GeometricField< Type, PatchField, GeoMesh >::Boundary::Boundary(), clear(), dict, entry::dict(), Foam::constant::electromagnetic::e, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAll, forAllConstIter(), found, dictionary::found(), InfoInFunction, entry::isDict(), keyType::isPattern(), entry::keyword(), Foam::name(), Foam::New(), patchi, UILList< LListBase, T >::rbegin(), UILList< LListBase, T >::rend(), setSize(), and dictionary::subDict().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

Update the boundary condition coefficients.

Definition at line 400 of file GeometricBoundaryField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::Boundary::evaluate(), forAll, InfoInFunction, UPtrList< T >::operator[](), and patchi.

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::Boundary().

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

References UPstream::blocking, UPstream::commsTypeNames, UPstream::defaultCommsType, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, InfoInFunction, UPstream::nonBlocking, UPstream::nRequests(), UPtrList< T >::operator[](), UPstream::parRun(), patchi, UPstream::scheduled, GeometricField< Type, PatchField, GeoMesh >::Boundary::types(), and UPstream::waitRequests().

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ types()

Foam::wordList types ( ) const

Return a list of the patch types.

Definition at line 483 of file GeometricBoundaryField.C.

References GeometricField< Type, PatchField, GeoMesh >::Boundary::boundaryInternalField(), forAll, patchi, and UPtrList< T >::size().

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryInternalField()

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

Return BoundaryField of the cell values neighbouring.

the boundary

Definition at line 501 of file GeometricBoundaryField.C.

References forAll, GeometricField< Type, PatchField, GeoMesh >::Boundary::interfaces(), UPtrList< T >::operator[](), and patchi.

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::types().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References forAll, Foam::isA(), patchi, Foam::refCast(), GeometricField< Type, PatchField, GeoMesh >::Boundary::scalarInterfaces(), UPtrList< const LduInterfaceField< Type > >::set(), and UPtrList< T >::size().

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::boundaryInternalField(), and GeometricField< Type, PatchField, GeoMesh >::Boundary::scalarInterfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References forAll, GeometricField< Type, PatchField, GeoMesh >::Boundary::interfaces(), patchi, UPtrList< T >::set(), UPtrList< T >::size(), and GeometricField< Type, PatchField, GeoMesh >::Boundary::writeEntry().

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::interfaces().

Here is the call graph for this function:

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

References token::BEGIN_BLOCK, IOstream::check(), Foam::decrIndent(), token::END_BLOCK, Foam::endl(), forAll, Foam::incrIndent(), Foam::indent(), Foam::nl, FieldField< PatchField, Type >::operator, FieldField< Field, Type >::operator=(), UPtrList< T >::operator[](), and patchi.

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::scalarInterfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/3]

void operator= ( const Boundary & )

Assignment to BoundaryField<Type, PatchField, BoundaryMesh>

◆ operator=() [2/3]

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

Assignment to FieldField<PatchField, Type>

Definition at line 610 of file GeometricBoundaryField.C.

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

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( const Type & t )

Assignment to Type.

Definition at line 621 of file GeometricBoundaryField.C.

References forAll, FieldField< PatchField, Type >::operator, FieldField< Field, Type >::operator=(), UPtrList< T >::operator[](), and patchi.

Here is the call graph for this function:

◆ operator==() [1/3]

void operator== ( const Boundary & )

Forced assignment to.

BoundaryField<Type, PatchField, BoundaryMesh>

◆ operator==() [2/3]

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

Forced assignment to FieldField<PatchField, Type>

Definition at line 647 of file GeometricBoundaryField.C.

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

Here is the call graph for this function:

◆ operator==() [3/3]

void operator== ( const Type & t )

Forced assignment to Type.

Definition at line 661 of file GeometricBoundaryField.C.

References forAll, UPtrList< T >::operator[](), and patchi.

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type, template< class > class PatchField, class GeoMesh> class Foam::GeometricField< Type, PatchField, GeoMesh >::Boundary

Constructor & Destructor Documentation

◆ Boundary() [1/7]

◆ Boundary() [2/7]

◆ Boundary() [3/7]

◆ Boundary() [4/7]

◆ Boundary() [5/7]

◆ Boundary() [6/7]

◆ Boundary() [7/7]

Member Function Documentation

◆ readField()

◆ updateCoeffs()

◆ evaluate()

◆ types()

◆ boundaryInternalField()

◆ interfaces()

◆ scalarInterfaces()

◆ writeEntry()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

template<class Type, template< class > class PatchField, class GeoMesh>
class Foam::GeometricField< Type, PatchField, GeoMesh >::Boundary