This boundary condition enables processor communication across cyclic patches. More...

Inheritance diagram for processorCyclicFvPatchField< Type >:

Collaboration diagram for processorCyclicFvPatchField< Type >:

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

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

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

	processorCyclicFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	processorCyclicFvPatchField (const processorCyclicFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given processorCyclicFvPatchField onto a. More...

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

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

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

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

virtual	~processorCyclicFvPatchField ()
	Destructor. More...

virtual bool	doTransform () const
	Does the patch field perform the transfromation. More...

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

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

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

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

	processorFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	processorFvPatchField (const processorFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given processorFvPatchField onto a new patch. More...

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

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

	~processorFvPatchField ()
	Destructor. More...

virtual bool	coupled () const
	Return true if running parallel. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return neighbour field given internal field. 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 > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient. More...

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

virtual void	initInterfaceMatrixUpdate (scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

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

virtual void	initInterfaceMatrixUpdate (Field< Type > &result, const Field< Type > &psiInternal, const scalarField &coeffs, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

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

virtual label	comm () const
	Processor coupled interface functions. More...

virtual int	myProcNo () const
	Return processor number. More...

virtual int	neighbProcNo () const
	Return neigbour processor number. More...

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

void	initInterfaceMatrixUpdate (scalarField &, const scalarField &psiInternal, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

void	updateInterfaceMatrix (scalarField &result, const scalarField &, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

void	initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

void	updateInterfaceMatrix (scalarField &result, const scalarField &, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

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

	processorLduInterfaceField ()
	Construct given coupled patch. More...

virtual	~processorLduInterfaceField ()
	Destructor. More...

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

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

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

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

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

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given coupledFvPatchField onto a new patch. More...

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

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

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. 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 scalarField &deltaCoeffs) const
	Return the matrix diagonal 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 scalarField &deltaCoeffs) const
	Return the matrix source 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< Type >
	TypeName ("LduInterfaceField")
	Runtime type information. More...

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

virtual	~LduInterfaceField ()
	Destructor. More...

virtual void	initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...

virtual void	updateInterfaceMatrix (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const=0
	Inherit updateInterfaceMatrix from lduInterfaceField. More...

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

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

virtual	~lduInterfaceField ()
	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...

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

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

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

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

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

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

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

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

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

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

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

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

virtual	~fvPatchField ()
	Destructor. More...

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

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

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

const Field< Type > &	internalField () 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...

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

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

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

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

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

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

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

virtual void	updateCoeffs (const scalarField &weights)
	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 void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. 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	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

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

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

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

virtual void	operator= (const Type &)

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

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

virtual void	operator+= (const Type &)

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

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

virtual void	operator-= (const Type &)

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

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

virtual void	operator*= (const scalar)

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

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

virtual void	operator/= (const scalar)

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

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

virtual void	operator== (const Type &)

Private Attributes
const processorCyclicFvPatch &	procPatch_
	Local reference cast into the processor patch. More...

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

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

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

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

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

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

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

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

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

template<class Type>
class Foam::processorCyclicFvPatchField< Type >

This boundary condition enables processor communication across cyclic patches.

Patch usage

Example of the boundary condition specification:

myPatch
{
    type            processor;
}

See also: Foam::processorFvPatchField

Source files

Definition at line 70 of file processorCyclicFvPatchField.H.

Constructor & Destructor Documentation

◆ processorCyclicFvPatchField() [1/6]

processorCyclicFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file processorCyclicFvPatchField.C.

◆ processorCyclicFvPatchField() [2/6]

processorCyclicFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const Field< Type > &	f
	)

Construct from patch and internal field and patch field.

Definition at line 47 of file processorCyclicFvPatchField.C.

◆ processorCyclicFvPatchField() [3/6]

processorCyclicFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 87 of file processorCyclicFvPatchField.C.

References dict, dimensionedInternalField(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, p, and WarningInFunction.

Here is the call graph for this function:

◆ processorCyclicFvPatchField() [4/6]

processorCyclicFvPatchField	(	const processorCyclicFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given processorCyclicFvPatchField onto a.

new patch

Definition at line 62 of file processorCyclicFvPatchField.C.

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

Here is the call graph for this function:

◆ processorCyclicFvPatchField() [5/6]

processorCyclicFvPatchField ( const processorCyclicFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 121 of file processorCyclicFvPatchField.C.

◆ processorCyclicFvPatchField() [6/6]

processorCyclicFvPatchField	(	const processorCyclicFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 134 of file processorCyclicFvPatchField.C.

◆ ~processorCyclicFvPatchField()

~processorCyclicFvPatchField

virtual

Destructor.

Definition at line 148 of file processorCyclicFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( processorCyclicFvPatch::typeName_() )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from processorFvPatchField< Type >.

Definition at line 124 of file processorCyclicFvPatchField.H.

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from processorFvPatchField< Type >.

Definition at line 141 of file processorCyclicFvPatchField.H.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Does the patch field perform the transfromation.

Reimplemented from processorFvPatchField< Type >.

Definition at line 161 of file processorCyclicFvPatchField.H.

References processorCyclicFvPatch::parallel(), and processorCyclicFvPatchField< Type >::procPatch_.

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Reimplemented from processorFvPatchField< Type >.

Definition at line 167 of file processorCyclicFvPatchField.H.

References processorCyclicFvPatch::forwardT(), and processorCyclicFvPatchField< Type >::procPatch_.

Here is the call graph for this function:

Field Documentation

◆ procPatch_

const processorCyclicFvPatch& procPatch_

private

Local reference cast into the processor patch.

Definition at line 77 of file processorCyclicFvPatchField.H.

Referenced by processorCyclicFvPatchField< Type >::doTransform(), and processorCyclicFvPatchField< Type >::forwardT().

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

src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H
src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::processorCyclicFvPatchField< Type >

Constructor & Destructor Documentation

◆ processorCyclicFvPatchField() [1/6]

◆ processorCyclicFvPatchField() [2/6]

◆ processorCyclicFvPatchField() [3/6]

◆ processorCyclicFvPatchField() [4/6]

◆ processorCyclicFvPatchField() [5/6]

◆ processorCyclicFvPatchField() [6/6]

◆ ~processorCyclicFvPatchField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ doTransform()

◆ forwardT()

Field Documentation

◆ procPatch_

template<class Type>
class Foam::processorCyclicFvPatchField< Type >