An abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used. More...

Inheritance diagram for fvsPatchField< Type >:

[legend]

Collaboration diagram for fvsPatchField< Type >:

[legend]

Public Types
typedef fvPatch	Patch

typedef calculatedFvsPatchField< Type >	Calculated

Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Public Types inherited from List< Type >
typedef SubList< Type >	subList
	Declare type of subList. More...

Public Types inherited from UList< Type >
typedef Type	value_type
	Type of values the UList contains. More...

typedef Type &	reference
	Type that can be used for storing into. More...

typedef const Type &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef Type *	iterator
	Random access iterator for traversing UList. More...

typedef const Type *	const_iterator
	Random access iterator for traversing UList. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Public Member Functions
	TypeName ("fvsPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvsPatchField, patch,(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvsPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const dictionary &dict),(p, iF, dict))

	declareRunTimeSelectionTable (tmp, fvsPatchField, patchMapper,(const fvsPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const fieldMapper &m),(dynamic_cast< const fvsPatchFieldType & >(ptf), p, iF, m))

	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
	Construct from patch and internal field. More...

	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fvsPatchField (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fieldMapper &, const bool mappingRequired=true)
	Construct by mapping the given fvsPatchField onto a new patch. More...

	fvsPatchField (const fvsPatchField< Type > &)=delete
	Disallow copy without setting internal field reference. More...

tmp< fvsPatchField< Type > >	clone () const
	Disallow clone without setting internal field reference. More...

	fvsPatchField (const fvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< fvsPatchField< Type > >	clone (const DimensionedField< Type, surfaceMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual tmp< fvsPatchField< Type > >	clone (const fvPatch &patch, const DimensionedField< Type, surfaceMesh > &iF) const
	Construct and return a clone onto a new patch. More...

virtual	~fvsPatchField ()
	Destructor. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	overridesConstraint () const
	Return true if this overrides the underlying constraint type. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, surfaceMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

virtual void	initPatchNeighbourField (const Pstream::commsTypes commsType) const
	Initialise return of the patchField on the opposite patch of a. More...

virtual tmp< Field< Type > >	patchNeighbourField (const Pstream::commsTypes commsType) const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	map (const fvsPatchField< Type > &, const fieldMapper &)
	Map the given fvsPatchField onto this fvsPatchField. More...

virtual void	reset (const fvsPatchField< Type > &)
	Reset the fvsPatchField to the given fvsPatchField. More...

virtual void	write (Ostream &) const
	Write. More...

void	check (const fvsPatchField< Type > &) const
	Check fvsPatchField<Type> against given fvsPatchField<Type> More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvsPatchField< Type > &)

virtual void	operator+= (const fvsPatchField< Type > &)

virtual void	operator-= (const fvsPatchField< Type > &)

virtual void	operator*= (const fvsPatchField< scalar > &)

virtual void	operator/= (const fvsPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

virtual void	operator== (const fvsPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::fvsPatchField< Type > >	NewCalculatedType (const fvsPatchField< Type2 > &pf)

Public Member Functions inherited from Field< Type >
	Field ()
	Construct null. More...

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

	Field (const label, const Type &)
	Construct given size and initial value. More...

	Field (const label, const zero)
	Construct given size and initialised to zero. More...

	Field (const UList< Type > &)
	Copy constructor of a UList<Type> More...

	Field (List< Type > &&)
	Mover constructor transferring the List contents. More...

	Field (const UIndirectList< Type > &)
	Copy constructor of a UIndirectList<Type> More...

	Field (const Field< Type > &)
	Copy constructor. More...

	Field (Field< Type > &, bool reuse)
	Copy constructor or reuse as specified. More...

	Field (Field< Type > &&)
	Move constructor transferring the Field contents. More...

	Field (const tmp< Field< Type >> &)
	Copy constructor of tmp<Field> More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

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

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

	Field (const word &keyword, const unitConversion &, const dictionary &, const label size)
	Construct from a dictionary entry with unit conversion. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	reset (const Field< Type > &)
	Reset the field values to the given field. More...

void	negate ()
	Negate this field. More...

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

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

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

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

template<class VSForm >
VSForm	block (const label start) const

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

void	operator= (const Field< Type > &)

void	operator= (Field< Type > &&)

void	operator= (const UList< Type > &)

void	operator= (List< Type > &&)

void	operator= (const SubField< Type > &)

void	operator= (const tmp< Field< Type >> &)

void	operator= (const Type &)

void	operator= (const zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type >
void	operator= (const tmp< Field > &rhs)

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 List< Type >
	List ()
	Null constructor. More...

	List (const label)
	Construct with given size. More...

	List (const label, const Type &)
	Construct with given size and value for all elements. More...

	List (const label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< Type > &)
	Copy constructor. More...

	List (const UList< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< Type > &&)
	Move constructor. More...

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

	List (const UList< Type > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< Type, Size > &)
	Construct as copy of FixedList<T, Size> More...

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

	List (const SLList< Type > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< Type > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< Type > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< Type >)
	Construct from an initialiser list. More...

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

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

autoPtr< List< Type > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

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

void	resize (const label, const Type &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const Type &)
	Reset size of List and value for new elements. More...

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

void	append (const Type &)
	Append an element at the end of the list. More...

void	append (const UList< Type > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< Type > &)
	Append a UIndirectList at the end of this list. More...

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

void	transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< Type > &)
	Transfer the contents of the argument List into this list. More...

Type &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< Type > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< Type > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< Type > &)
	Assignment operator. Takes linear time. More...

void	operator= (List< Type > &&)
	Move assignment operator. More...

void	operator= (const SLList< Type > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< Type > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< Type > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< Type >)
	Assignment to an initialiser list. More...

void	operator= (const Type &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

Public Member Functions inherited from UList< Type >
void	operator= (const Type &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

	UList ()
	Null constructor. More...

	UList (Type *__restrict__ v, label size)
	Construct from components. More...

	UList (const UList< Type > &)=default
	Copy construct. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const Type *	cdata () const
	Return a const pointer to the first data element,. More...

Type *	data ()
	Return a pointer to the first data element,. More...

Type &	first ()
	Return the first element of the list. More...

const Type &	first () const
	Return first element of the list. More...

Type &	last ()
	Return the last element of the list. More...

const Type &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< Type > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< Type > &)
	Copy elements of the given UList. More...

Type &	operator[] (const label)
	Return element of UList. More...

const Type &	operator[] (const label) const
	Return element of constant UList. More...

const bool &	operator[] (const label i) const

	operator const Foam::List< Type > & () const
	Allow cast to a const List<T>&. More...

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

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

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

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

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

label	max_size () const
	Return size of the largest possible UList. More...

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

void	swap (UList< Type > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< Type > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< Type > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< Type > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< Type > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< Type > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< Type > &) const
	Return true if !(a < b). Takes linear time. More...

Static Public Member Functions
static tmp< fvsPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvsPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvsPatchField< Type > >	New (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvsPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvsPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvsPatchField created on. More...

template<class Type2 >
static tmp< fvsPatchField< Type > >	NewCalculatedType (const fvsPatchField< Type2 > &)
	Return a pointer to a new calculatedFvsPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvsPatchField. More...

Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()
	Return a null field. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Static Public Member Functions inherited from List< Type >
static const List< Type > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< Type >
static const UList< Type > &	null ()
	Return a null UList. More...

Static Public Attributes
static int	disallowGenericFvsPatchField
	Debug switch to disallow the use of genericFvsPatchField. More...

Static Public Attributes inherited from Field< Type >
static const char *const	typeName

Friends
Ostream &	operator (Ostream &, const fvsPatchField< Type > &)

Additional Inherited Members
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 List< Type >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

template<class Type>
class Foam::fvsPatchField< Type >

An abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used.

The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions.

The next level of derivation covers all the specialised typed with specific evaluation procedures, particularly with respect to specific fields.

Source files

Definition at line 80 of file fvsPatchField.H.

Member Typedef Documentation

◆ Patch

typedef fvPatch Patch

Definition at line 95 of file fvsPatchField.H.

◆ Calculated

typedef calculatedFvsPatchField<Type> Calculated

Definition at line 96 of file fvsPatchField.H.

Constructor & Destructor Documentation

◆ fvsPatchField() [1/6]

fvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file fvsPatchField.C.

◆ fvsPatchField() [2/6]

fvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const Field< Type > &	f
	)

Construct from patch and internal field and patch field.

Definition at line 48 of file fvsPatchField.C.

◆ fvsPatchField() [3/6]

fvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const dictionary &	dict,
		const bool	valueRequired = `true`
	)

Construct from patch, internal field and dictionary.

Definition at line 62 of file fvsPatchField.C.

References dict, DimensionedField< Type, GeoMesh >::dimensions(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and p.

Here is the call graph for this function:

◆ fvsPatchField() [4/6]

fvsPatchField	(	const fvsPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const fieldMapper &	mapper,
		const bool	mappingRequired = `true`
	)

Construct by mapping the given fvsPatchField onto a new patch.

Definition at line 96 of file fvsPatchField.C.

◆ fvsPatchField() [5/6]

fvsPatchField ( const fvsPatchField< Type > & )

delete

Disallow copy without setting internal field reference.

◆ fvsPatchField() [6/6]

fvsPatchField	(	const fvsPatchField< Type > &	ptf,
		const DimensionedField< Type, surfaceMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 117 of file fvsPatchField.C.

◆ ~fvsPatchField()

virtual ~fvsPatchField ( )

inlinevirtual

Destructor.

Definition at line 295 of file fvsPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "fvsPatchField< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable	(	tmp	,
		fvsPatchField< Type >	,
		patch	,
		(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF)	,
		(p, iF)
	)

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	tmp	,
		fvsPatchField< Type >	,
		dictionary	,
		(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const dictionary &dict)	,
		(p, iF, dict)
	)

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable	(	tmp	,
		fvsPatchField< Type >	,
		patchMapper	,
		(const fvsPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const fieldMapper &m)	,
		(dynamic_cast< const fvsPatchFieldType & >(ptf), p, iF, m)
	)

◆ clone() [1/3]

tmp<fvsPatchField<Type> > clone ( ) const

inline

Disallow clone without setting internal field reference.

Definition at line 188 of file fvsPatchField.H.

◆ clone() [2/3]

virtual tmp<fvsPatchField<Type> > clone ( const DimensionedField< Type, surfaceMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in conformedFvsPatchField< Type >, wedgeFvsPatchField< Type >, symmetryPlaneFvsPatchField< Type >, symmetryFvsPatchField< Type >, processorCyclicFvsPatchField< Type >, processorFvsPatchField< Type >, nonConformalProcessorCyclicFvsPatchField< Type >, nonConformalErrorFvsPatchField< Type >, nonConformalCyclicFvsPatchField< Type >, internalFvsPatchField< Type >, emptyFvsPatchField< Type >, cyclicSlipFvsPatchField< Type >, cyclicFvsPatchField< Type >, slicedFvsPatchField< Type >, fixedValueFvsPatchField< Type >, calculatedFvsPatchField< Type >, and coupledFvsPatchField< Type >.

Definition at line 209 of file fvsPatchField.H.

◆ clone() [3/3]

virtual tmp<fvsPatchField<Type> > clone	(	const fvPatch &	patch,
		const DimensionedField< Type, surfaceMesh > &	iF
	)		const

inlinevirtual

Construct and return a clone onto a new patch.

setting internal field reference

Reimplemented in processorCyclicFvsPatchField< Type >, processorFvsPatchField< Type >, and nonConformalProcessorCyclicFvsPatchField< Type >.

Definition at line 222 of file fvsPatchField.H.

◆ New() [1/4]

Foam::tmp< Foam::fvsPatchField< Type > > New	(	const word &	patchFieldType,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF
	)

static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

Definition at line 86 of file fvsPatchFieldNew.C.

References Foam::compressible::New(), p, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [2/4]

Foam::tmp< Foam::fvsPatchField< Type > > New	(	const word &	patchFieldType,
		const word &	actualPatchType,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF
	)

static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values) Allows override of constraint type

Definition at line 29 of file fvsPatchFieldNew.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, IOobject::name(), Foam::nl, p, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [3/4]

Foam::tmp< Foam::fvsPatchField< Type > > New	(	const fvsPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const fieldMapper &	pfMapper
	)

static

Return a pointer to a new patchField created on freestore from.

a given fvsPatchField mapped onto a new patch

Definition at line 172 of file fvsPatchFieldNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, IOobject::name(), Foam::nl, and p.

Here is the call graph for this function:

◆ New() [4/4]

Foam::tmp< Foam::fvsPatchField< Type > > New	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const dictionary &	dict
	)

static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 98 of file fvsPatchFieldNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, IOobject::name(), Foam::nl, p, and Foam::patchFieldType().

Here is the call graph for this function:

◆ NewCalculatedType() [1/3]

Foam::tmp< Foam::fvsPatchField< Type > > NewCalculatedType ( const fvPatch & p )

static

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

Definition at line 94 of file calculatedFvsPatchField.C.

References DimensionedField< Type, GeoMesh >::null(), and p.

Here is the call graph for this function:

◆ NewCalculatedType() [2/3]

static tmp<fvsPatchField<Type> > NewCalculatedType ( const fvsPatchField< Type2 > & )

static

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

◆ calculatedType()

const Foam::word & calculatedType

static

Return the type of the calculated for of fvsPatchField.

Definition at line 32 of file calculatedFvsPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 309 of file fvsPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is coupled.

Reimplemented in processorCyclicFvsPatchField< Type >, processorFvsPatchField< Type >, and coupledFvsPatchField< Type >.

Definition at line 315 of file fvsPatchField.H.

Referenced by Foam::adjustPhi(), CentredFitSnGradData< Polynomial >::calcFit(), phaseModel::correctInflowOutflow(), linearUpwindV< Type >::correction(), pointLinear< Type >::correction(), linearUpwind< Type >::correction(), interfaceCompressionNew::interpolate(), Foam::MULES::limit(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), extendedCellToFaceStencil::weightedSum(), and extendedUpwindCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

◆ overridesConstraint()

bool overridesConstraint ( ) const

inline

Return true if this overrides the underlying constraint type.

Definition at line 321 of file fvsPatchField.H.

References Foam::type().

Here is the call graph for this function:

◆ db()

const Foam::objectRegistry & db

Return local objectRegistry.

Definition at line 132 of file fvsPatchField.C.

◆ patch()

const fvPatch& patch ( ) const

inline

Return patch.

Definition at line 343 of file fvsPatchField.H.

Here is the caller graph for this function:

◆ internalField()

const DimensionedField<Type, surfaceMesh>& internalField ( ) const

inline

Return dimensioned internal field reference.

Definition at line 350 of file fvsPatchField.H.

Referenced by fanPressureFvPatchScalarField::updateCoeffs(), and fanPressureJumpFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ primitiveField()

const Field<Type>& primitiveField ( ) const

inline

Return internal field reference.

Definition at line 356 of file fvsPatchField.H.

◆ initPatchNeighbourField()

virtual void initPatchNeighbourField ( const Pstream::commsTypes commsType ) const

inlinevirtual

Initialise return of the patchField on the opposite patch of a.

coupled patch

Reimplemented in processorFvsPatchField< Type >.

Definition at line 366 of file fvsPatchField.H.

◆ patchNeighbourField()

virtual tmp<Field<Type> > patchNeighbourField ( const Pstream::commsTypes commsType ) const

inlinevirtual

Return patchField on the opposite patch of a coupled patch.

Reimplemented in processorFvsPatchField< Type >, and cyclicFvsPatchField< Type >.

Definition at line 373 of file fvsPatchField.H.

References NotImplemented.

◆ map()

void map	(	const fvsPatchField< Type > &	ptf,
		const fieldMapper &	mapper
	)

virtual

Map the given fvsPatchField onto this fvsPatchField.

Reimplemented in conformedFvsPatchField< Type >, and emptyFvsPatchField< Type >.

Definition at line 151 of file fvsPatchField.C.

Referenced by conformedFvsPatchField< Type >::map().

Here is the caller graph for this function:

◆ reset()

void reset ( const fvsPatchField< Type > & ptf )

virtual

Reset the fvsPatchField to the given fvsPatchField.

Used for mesh to mesh mapping

Reimplemented in conformedFvsPatchField< Type >, and emptyFvsPatchField< Type >.

Definition at line 162 of file fvsPatchField.C.

References Field< Type >::reset().

Referenced by conformedFvsPatchField< Type >::reset(), and nonConformalMappedPolyFacesFvsPatchLabelField::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in conformedFvsPatchField< Type >, nonConformalPolyFacesFvsPatchLabelField, nonConformalMappedPolyFacesFvsPatchLabelField, wedgeFvsPatchField< Type >, symmetryPlaneFvsPatchField< Type >, symmetryFvsPatchField< Type >, nonConformalErrorFvsPatchField< Type >, internalFvsPatchField< Type >, slicedFvsPatchField< Type >, fixedValueFvsPatchField< Type >, coupledFvsPatchField< Type >, and calculatedFvsPatchField< Type >.

Definition at line 169 of file fvsPatchField.C.

References Foam::type(), and Foam::writeEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check()

void check ( const fvsPatchField< Type > & ptf ) const

Check fvsPatchField<Type> against given fvsPatchField<Type>

Definition at line 139 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ operator=() [1/3]

void operator= ( const UList< Type > & ul )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 183 of file fvsPatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ operator=() [2/3]

void operator= ( const fvsPatchField< Type > & ptf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 193 of file fvsPatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ operator+=() [1/3]

void operator+= ( const fvsPatchField< Type > & ptf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 204 of file fvsPatchField.C.

References Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [1/3]

void operator-= ( const fvsPatchField< Type > & ptf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 215 of file fvsPatchField.C.

References Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [1/3]

void operator*= ( const fvsPatchField< scalar > & ptf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 226 of file fvsPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator*=().

Here is the call graph for this function:

◆ operator/=() [1/3]

void operator/= ( const fvsPatchField< scalar > & ptf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 243 of file fvsPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator/=().

Here is the call graph for this function:

◆ operator+=() [2/3]

void operator+= ( const Field< Type > & tf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 259 of file fvsPatchField.C.

References Field< Type >::operator+=(), and tf.

Here is the call graph for this function:

◆ operator-=() [2/3]

void operator-= ( const Field< Type > & tf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 269 of file fvsPatchField.C.

References Field< Type >::operator-=(), and tf.

Here is the call graph for this function:

◆ operator*=() [2/3]

void operator*= ( const Field< scalar > & tf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 279 of file fvsPatchField.C.

References Field< Type >::operator*=(), and tf.

Here is the call graph for this function:

◆ operator/=() [2/3]

void operator/= ( const Field< scalar > & tf )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 289 of file fvsPatchField.C.

References Field< Type >::operator/=(), and tf.

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( const Type & t )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 299 of file fvsPatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ operator+=() [3/3]

void operator+= ( const Type & t )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 309 of file fvsPatchField.C.

References Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [3/3]

void operator-= ( const Type & t )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 319 of file fvsPatchField.C.

References Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [3/3]

void operator*= ( const scalar s )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 329 of file fvsPatchField.C.

References Field< Type >::operator*=(), and s().

Here is the call graph for this function:

◆ operator/=() [3/3]

void operator/= ( const scalar s )

virtual

Reimplemented in slicedFvsPatchField< Type >, and fixedValueFvsPatchField< Type >.

Definition at line 339 of file fvsPatchField.C.

References Field< Type >::operator/=(), and s().

Here is the call graph for this function:

◆ operator==() [1/3]

void operator== ( const fvsPatchField< Type > & ptf )

virtual

Definition at line 349 of file fvsPatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ operator==() [2/3]

void operator== ( const Field< Type > & tf )

virtual

Definition at line 359 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ operator==() [3/3]

void operator== ( const Type & t )

virtual

Definition at line 369 of file fvsPatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ NewCalculatedType() [3/3]

Foam::tmp<Foam::fvsPatchField<Type> > NewCalculatedType ( const fvsPatchField< Type2 > & pf )

Definition at line 127 of file calculatedFvsPatchField.C.

References fvsPatchField< Type >::patch().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const fvsPatchField< Type > &
	)

friend

Member Data Documentation

◆ disallowGenericFvsPatchField

int disallowGenericFvsPatchField

static

Debug switch to disallow the use of genericFvsPatchField.

Definition at line 103 of file fvsPatchField.H.

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

src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchField.H
src/finiteVolume/fields/fvsPatchFields/basic/calculated/calculatedFvsPatchField.C
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchField.C
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchFieldNew.C
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchFields.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fvsPatchField< Type >

Member Typedef Documentation

◆ Patch

◆ Calculated

Constructor & Destructor Documentation

◆ fvsPatchField() [1/6]

◆ fvsPatchField() [2/6]

◆ fvsPatchField() [3/6]

◆ fvsPatchField() [4/6]

◆ fvsPatchField() [5/6]

◆ fvsPatchField() [6/6]

◆ ~fvsPatchField()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ NewCalculatedType() [1/3]

◆ NewCalculatedType() [2/3]

◆ calculatedType()

◆ fixesValue()

◆ coupled()

◆ overridesConstraint()

◆ db()

◆ patch()

◆ internalField()

◆ primitiveField()

◆ initPatchNeighbourField()

◆ patchNeighbourField()

◆ map()

◆ reset()

◆ write()

◆ check()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator+=() [1/3]

◆ operator-=() [1/3]

◆ operator*=() [1/3]

◆ operator/=() [1/3]

◆ operator+=() [2/3]

◆ operator-=() [2/3]

◆ operator*=() [2/3]

◆ operator/=() [2/3]

◆ operator=() [3/3]

◆ operator+=() [3/3]

◆ operator-=() [3/3]

◆ operator*=() [3/3]

◆ operator/=() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ NewCalculatedType() [3/3]

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ disallowGenericFvsPatchField

template<class Type>
class Foam::fvsPatchField< Type >