Inheritance diagram for cyclicFaPatchField< Type >:

Collaboration diagram for cyclicFaPatchField< Type >:

Public Member Functions
	TypeName (cyclicFaPatch::typeName_())
	Runtime type information. More...

	cyclicFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	cyclicFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	cyclicFaPatchField (const cyclicFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping given cyclicFaPatchField onto a new patch. More...

	cyclicFaPatchField (const cyclicFaPatchField< Type > &)
	Construct as copy. More...

virtual tmp< faPatchField< Type > >	clone () const
	Construct and return a clone. More...

	cyclicFaPatchField (const cyclicFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

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

const cyclicFaPatch &	cyclicPatch () const
	Return local reference cast into the cyclic patch. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return neighbour coupled given internal cell data. More...

virtual void	transformCoupleField (solveScalarField &f, const direction cmpt) const
	Transform neighbour field. More...

virtual void	updateInterfaceMatrix (solveScalarField &result, const bool add, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

virtual void	updateInterfaceMatrix (Field< Type > &result, const bool add, const Field< Type > &, const scalarField &coeffs, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

virtual bool	doTransform () const
	Cyclic coupled interface functions. More...

virtual const tensorField &	forwardT () const
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor. More...

virtual int	rank () const
	Return rank of component for transform. More...

Public Member Functions inherited from cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")
	Runtime type information. More...

	cyclicLduInterfaceField ()=default
	Construct null. More...

virtual	~cyclicLduInterfaceField ()=default
	Destructor. More...

template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...

void	transformCoupleField (solveScalarField &f, const direction cmpt) const
	Transform given patch component field. More...

Public Member Functions inherited from coupledFaPatchField< Type >
	TypeName (coupledFaPatch::typeName_())
	Runtime type information. More...

	coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	coupledFaPatchField (const coupledFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given coupledFaPatchField onto a new patch. More...

	coupledFaPatchField (const coupledFaPatchField< Type > &)
	Construct as copy. More...

	coupledFaPatchField (const coupledFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

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

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

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

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information. More...

	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

virtual	~lduInterfaceField ()=default
	Destructor. More...

const lduInterface &	interface () const
	Return the interface. More...

virtual const word &	interfaceFieldType () const
	Return the interface type. More...

bool	updatedMatrix () const
	Whether matrix has been updated. More...

bool &	updatedMatrix ()
	Whether matrix has been updated. More...

virtual bool	ready () const
	Is all data available. More...

virtual void	initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const

template<class Type >
void	addToInternalField (Field< Type > &result, const bool add, const scalarField &coeffs, const Field< Type > &vals) const
	Add/subtract weighted contributions to internal field. More...

Public Member Functions inherited from faPatchField< Type >
	TypeName ("faPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given faPatchField onto a new patch. More...

	faPatchField (const faPatchField< Type > &)
	Construct as copy. More...

	faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

virtual	~faPatchField ()=default
	Destructor. More...

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

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

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

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

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

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

bool	updated () const
	Return true if the boundary condition has already been updated. More...

virtual void	autoMap (const faPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const faPatchField< Type > &, const labelList &)
	Reverse map the given faPatchField onto this faPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source coefficients corresponding to the. More...

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

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

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

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

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

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

virtual void	operator/= (const faPatchField< 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 faPatchField< Type > &)

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

virtual void	operator== (const Type &)

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

Additional Inherited Members
Public Types inherited from faPatchField< Type >
typedef faPatch	Patch

typedef calculatedFaPatchField< Type >	Calculated

Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

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

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

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

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField
	Debug switch to disallow the use of. More...

Detailed Description

template<class Type>
class Foam::cyclicFaPatchField< Type >

Foam::cyclicFaPatchField.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 59 of file cyclicFaPatchField.H.

Constructor & Destructor Documentation

◆ cyclicFaPatchField() [1/5]

cyclicFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file cyclicFaPatchField.C.

◆ cyclicFaPatchField() [2/5]

cyclicFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 72 of file cyclicFaPatchField.C.

References dict, Foam::stringOps::evaluate(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and p.

Here is the call graph for this function:

◆ cyclicFaPatchField() [3/5]

cyclicFaPatchField	(	const cyclicFaPatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Construct by mapping given cyclicFaPatchField onto a new patch.

Definition at line 47 of file cyclicFaPatchField.C.

References Foam::exit(), FatalErrorInFunction, Foam::FatalIOError, p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ cyclicFaPatchField() [4/5]

cyclicFaPatchField ( const cyclicFaPatchField< Type > & ptf )

Construct as copy.

Definition at line 98 of file cyclicFaPatchField.C.

◆ cyclicFaPatchField() [5/5]

cyclicFaPatchField	(	const cyclicFaPatchField< Type > &	ptf,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 110 of file cyclicFaPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( cyclicFaPatch::typeName_() )

Runtime type information.

◆ clone() [1/2]

virtual tmp<faPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements coupledFaPatchField< Type >.

Definition at line 119 of file cyclicFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Implements coupledFaPatchField< Type >.

Definition at line 136 of file cyclicFaPatchField.H.

◆ cyclicPatch()

const cyclicFaPatch& cyclicPatch ( ) const

inline

Return local reference cast into the cyclic patch.

Definition at line 152 of file cyclicFaPatchField.H.

◆ patchNeighbourField()

Foam::tmp< Foam::Field< Type > > patchNeighbourField ( ) const

virtual

Return neighbour coupled given internal cell data.

Implements coupledFaPatchField< Type >.

Definition at line 124 of file cyclicFaPatchField.C.

References tmp< T >::ref(), and Foam::transform().

Here is the call graph for this function:

◆ transformCoupleField()

virtual void transformCoupleField	(	solveScalarField &	f,
		const direction	cmpt
	)		const

inlinevirtual

Transform neighbour field.

Implements coupledFaPatchField< Type >.

Definition at line 168 of file cyclicFaPatchField.H.

References f(), and cyclicLduInterfaceField::transformCoupleField().

Here is the call graph for this function:

◆ updateInterfaceMatrix() [1/2]

void updateInterfaceMatrix	(	solveScalarField &	result,
		const bool	add,
		const solveScalarField &	psiInternal,
		const scalarField &	coeffs,
		const direction	cmpt,
		const Pstream::commsTypes	commsType
	)		const

virtual

Update result field based on interface functionality.

Implements coupledFaPatchField< Type >.

Definition at line 164 of file cyclicFaPatchField.C.

References Foam::add(), and forAll.

Here is the call graph for this function:

◆ updateInterfaceMatrix() [2/2]

void updateInterfaceMatrix	(	Field< Type > &	result,
		const bool	add,
		const Field< Type > &	psiInternal,
		const scalarField &	coeffs,
		const Pstream::commsTypes	commsType
	)		const

virtual

Update result field based on interface functionality.

Implements coupledFaPatchField< Type >.

Definition at line 207 of file cyclicFaPatchField.C.

References Foam::add(), and forAll.

Here is the call graph for this function:

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Cyclic coupled interface functions.

Does the patch field perform the transformation

Implements cyclicLduInterfaceField.

Definition at line 201 of file cyclicFaPatchField.H.

References coupledFaPatch::parallel().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 207 of file cyclicFaPatchField.H.

References cyclicFaPatch::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 213 of file cyclicFaPatchField.H.

References cyclicFaPatch::reverseT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicLduInterfaceField.

Definition at line 219 of file cyclicFaPatchField.H.

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

src/finiteArea/fields/faPatchFields/constraint/cyclic/cyclicFaPatchField.H
src/finiteArea/fields/faPatchFields/constraint/cyclic/cyclicFaPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::cyclicFaPatchField< Type >

Constructor & Destructor Documentation

◆ cyclicFaPatchField() [1/5]

◆ cyclicFaPatchField() [2/5]

◆ cyclicFaPatchField() [3/5]

◆ cyclicFaPatchField() [4/5]

◆ cyclicFaPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ cyclicPatch()

◆ patchNeighbourField()

◆ transformCoupleField()

◆ updateInterfaceMatrix() [1/2]

◆ updateInterfaceMatrix() [2/2]

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

template<class Type>
class Foam::cyclicFaPatchField< Type >