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

Inheritance diagram for processorFvPatchField< Type >:

[legend]

Collaboration diagram for processorFvPatchField< Type >:

Public Member Functions
	TypeName (processorFvPatch::typeName_())

	processorFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	processorFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	processorFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	processorFvPatchField (const processorFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	processorFvPatchField (const processorFvPatchField< Type > &)

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

	processorFvPatchField (const processorFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

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

	~processorFvPatchField ()=default

virtual bool	coupled () const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual void	initEvaluate (const Pstream::commsTypes commsType)

virtual void	evaluate (const Pstream::commsTypes commsType)

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const

virtual bool	ready () const

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

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

virtual void	initInterfaceMatrixUpdate (Field< Type > &result, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &psiInternal, const scalarField &coeffs, const Pstream::commsTypes commsType) const

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

virtual label	comm () const

virtual int	myProcNo () const

virtual int	neighbProcNo () const

virtual bool	doTransform () const

virtual const tensorField &	forwardT () const

virtual int	rank () const

Public Member Functions inherited from processorLduInterfaceField
	TypeName ("processorLduInterfaceField")

	processorLduInterfaceField ()=default

virtual	~processorLduInterfaceField ()=default

template<class Type >
void	transformCoupleField (Field< Type > &f) const

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

Public Member Functions inherited from coupledFvPatchField< Type >
	TypeName (coupledFvPatch::typeName_())

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	coupledFvPatchField (const coupledFvPatchField< Type > &)

	coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< Field< Type > >	snGrad () const

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	write (Ostream &) const

Public Member Functions inherited from LduInterfaceField< Type >
	TypeName ("LduInterfaceField")

	LduInterfaceField (const lduInterface &patch)

virtual	~LduInterfaceField ()=default

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

virtual void	updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const=0

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")

	lduInterfaceField (const lduInterface &patch)

virtual	~lduInterfaceField ()=default

const lduInterface &	interface () const

virtual const word &	interfaceFieldType () const

bool	updatedMatrix () const

bool &	updatedMatrix ()

template<class Type >
void	addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")

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

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

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

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

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

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual bool	coupled () const

const objectRegistry &	db () const

const fvPatch &	patch () const

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

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchField< Type > &, const labelList &)

virtual tmp< Field< Type > >	snGrad () const

virtual void	updateCoeffs ()

virtual void	updateWeightedCoeffs (const scalarField &weights)

virtual tmp< Field< Type > >	patchInternalField () const

virtual void	patchInternalField (Field< Type > &) const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)

void	check (const fvPatchField< Type > &) const

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

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

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

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

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::processorFvPatchField< Type >

This boundary condition enables processor communication across patches.

Usage

Example of the boundary condition specification:

<patchName>
{
    type            processor;
}

Source files

Definition at line 62 of file processorFvPatchField.H.

Constructor & Destructor Documentation

◆ processorFvPatchField() [1/6]

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

Definition at line 31 of file processorFvPatchField.C.

◆ processorFvPatchField() [2/6]

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

Definition at line 49 of file processorFvPatchField.C.

◆ processorFvPatchField() [3/6]

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

Definition at line 68 of file processorFvPatchField.C.

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

Here is the call graph for this function:

◆ processorFvPatchField() [4/6]

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

Definition at line 104 of file processorFvPatchField.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::exit(), Foam::FatalError, FatalErrorInFunction, p, Foam::foamVersion::patch, and processorFvPatchField< Type >::ready().

Here is the call graph for this function:

◆ processorFvPatchField() [5/6]

processorFvPatchField ( const processorFvPatchField< Type > & ptf )

Definition at line 140 of file processorFvPatchField.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::FatalError, FatalErrorInFunction, and processorFvPatchField< Type >::ready().

Here is the call graph for this function:

◆ processorFvPatchField() [6/6]

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

Definition at line 165 of file processorFvPatchField.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::FatalError, FatalErrorInFunction, and processorFvPatchField< Type >::ready().

Here is the call graph for this function:

◆ ~processorFvPatchField()

~processorFvPatchField ( )

default

Member Function Documentation

◆ TypeName()

TypeName ( processorFvPatch::typeName_() )

◆ clone() [1/2]

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

inlinevirtual

Implements coupledFvPatchField< Type >.

Reimplemented in processorCyclicFvPatchField< Type >.

Definition at line 137 of file processorFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Implements coupledFvPatchField< Type >.

Reimplemented in processorCyclicFvPatchField< Type >.

Definition at line 154 of file processorFvPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Reimplemented from coupledFvPatchField< Type >.

Definition at line 174 of file processorFvPatchField.H.

References UPstream::parRun().

Here is the call graph for this function:

◆ patchNeighbourField()

Foam::tmp< Foam::Field< Type > > patchNeighbourField

virtual

Implements coupledFvPatchField< Type >.

Definition at line 192 of file processorFvPatchField.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ initEvaluate()

void initEvaluate ( const Pstream::commsTypes commsType )

virtual

Reimplemented from coupledFvPatchField< Type >.

Definition at line 207 of file processorFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::blockMeshTools::read(), setSize(), and Foam::vtk::write().

Here is the call graph for this function:

◆ evaluate()

void evaluate ( const Pstream::commsTypes commsType )

virtual

Reimplemented from coupledFvPatchField< Type >.

Definition at line 262 of file processorFvPatchField.C.

References Foam::transform().

Here is the call graph for this function:

◆ snGrad()

Foam::tmp< Foam::Field< Type > > snGrad ( const scalarField & deltaCoeffs ) const

virtual

Reimplemented from coupledFvPatchField< Type >.

Definition at line 303 of file processorFvPatchField.C.

◆ ready()

bool ready

virtual

Reimplemented from lduInterfaceField.

Definition at line 597 of file processorFvPatchField.C.

Referenced by processorFvPatchField< Type >::processorFvPatchField().

Here is the caller graph for this function:

◆ initInterfaceMatrixUpdate() [1/2]

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

virtual

Reimplemented from lduInterfaceField.

Definition at line 313 of file processorFvPatchField.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::FatalError, FatalErrorInFunction, forAll, Foam::foamVersion::patch, lduAddressing::patchAddr(), patchId(), Foam::blockMeshTools::read(), lduInterfaceField::updatedMatrix(), and Foam::vtk::write().

Here is the call graph for this function:

◆ updateInterfaceMatrix() [1/2]

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

virtual

Implements coupledFvPatchField< Type >.

Definition at line 384 of file processorFvPatchField.C.

References Foam::add(), lduAddressing::patchAddr(), patchId(), and lduInterfaceField::updatedMatrix().

Here is the call graph for this function:

◆ initInterfaceMatrixUpdate() [2/2]

void initInterfaceMatrixUpdate	(	Field< Type > &	result,
		const bool	add,
		const lduAddressing &	lduAddr,
		const label	patchId,
		const Field< Type > &	psiInternal,
		const scalarField &	coeffs,
		const Pstream::commsTypes	commsType
	)		const

virtual

Reimplemented from LduInterfaceField< Type >.

Definition at line 465 of file processorFvPatchField.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, Foam::FatalError, FatalErrorInFunction, forAll, Foam::foamVersion::patch, lduAddressing::patchAddr(), patchId(), Foam::blockMeshTools::read(), lduInterfaceField::updatedMatrix(), and Foam::vtk::write().

Here is the call graph for this function:

◆ updateInterfaceMatrix() [2/2]

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

virtual

Implements coupledFvPatchField< Type >.

Definition at line 534 of file processorFvPatchField.C.

References Foam::add(), lduAddressing::patchAddr(), patchId(), and lduInterfaceField::updatedMatrix().

Here is the call graph for this function:

◆ comm()

virtual label comm ( ) const

inlinevirtual

Implements processorLduInterfaceField.

Definition at line 262 of file processorFvPatchField.H.

References processorFvPatch::comm().

Here is the call graph for this function:

◆ myProcNo()

virtual int myProcNo ( ) const

inlinevirtual

Implements processorLduInterfaceField.

Definition at line 268 of file processorFvPatchField.H.

References processorFvPatch::myProcNo().

Here is the call graph for this function:

◆ neighbProcNo()

virtual int neighbProcNo ( ) const

inlinevirtual

Implements processorLduInterfaceField.

Definition at line 274 of file processorFvPatchField.H.

References processorFvPatch::neighbProcNo().

Here is the call graph for this function:

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Implements processorLduInterfaceField.

Reimplemented in processorCyclicFvPatchField< Type >.

Definition at line 280 of file processorFvPatchField.H.

References processorFvPatch::parallel().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Implements processorLduInterfaceField.

Reimplemented in processorCyclicFvPatchField< Type >.

Definition at line 286 of file processorFvPatchField.H.

References processorFvPatch::forwardT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const

inlinevirtual

Implements processorLduInterfaceField.

Definition at line 292 of file processorFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H
src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::processorFvPatchField< Type >

Constructor & Destructor Documentation

◆ processorFvPatchField() [1/6]

◆ processorFvPatchField() [2/6]

◆ processorFvPatchField() [3/6]

◆ processorFvPatchField() [4/6]

◆ processorFvPatchField() [5/6]

◆ processorFvPatchField() [6/6]

◆ ~processorFvPatchField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ coupled()

◆ patchNeighbourField()

◆ initEvaluate()

◆ evaluate()

◆ snGrad()

◆ ready()

◆ initInterfaceMatrixUpdate() [1/2]

◆ updateInterfaceMatrix() [1/2]

◆ initInterfaceMatrixUpdate() [2/2]

◆ updateInterfaceMatrix() [2/2]

◆ comm()

◆ myProcNo()

◆ neighbProcNo()

◆ doTransform()

◆ forwardT()

◆ rank()

template<class Type>
class Foam::processorFvPatchField< Type >