This boundary condition provides an energy jump condition across a pair of coupled patches with an arbitrary mesh interface (AMI). It is not applied directly, but is employed on-the-fly when converting temperature boundary conditions into energy. More...

Inheritance diagram for energyJumpAMIFvPatchScalarField:

[legend]

Collaboration diagram for energyJumpAMIFvPatchScalarField:

[legend]

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

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

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

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

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

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

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

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

virtual void	updateCoeffs ()
	Update the coefficients. More...

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

Public Member Functions inherited from fixedJumpAMIFvPatchField< scalar >
	TypeName ("fixedJumpAMI")
	Runtime type information. More...

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

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

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

	fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< scalar > &)
	Construct as copy. More...

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

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

virtual tmp< Field< scalar > >	jump () const
	Return the "jump" across the patch. More...

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

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

Public Member Functions inherited from jumpCyclicAMIFvPatchField< scalar >
	TypeName ("jumpCyclicAMI")
	Runtime type information. More...

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

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

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

	jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< scalar > &)
	Construct as copy. More...

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

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

tmp< Field< scalar > >	patchNeighbourField () const
	Return neighbour coupled given internal cell data. 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	updateInterfaceMatrix (Field< scalar > &, const Field< scalar > &, const scalarField &, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

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

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

Public Member Functions inherited from cyclicAMIFvPatchField< scalar >
	TypeName (cyclicAMIFvPatch::typeName_())
	Runtime type information. More...

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

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

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

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< scalar > &)
	Construct as copy. More...

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

const cyclicAMIFvPatch &	cyclicAMIPatch () const
	Return local reference cast into the cyclic AMI patch. More...

virtual bool	coupled () const
	Return true if coupled. Note that the underlying patch. More...

const cyclicAMIFvPatchField< scalar > &	neighbourPatchField () const
	Return reference to neighbour patchField. More...

virtual bool	doTransform () const
	Does the patch field perform the transformation. 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 cyclicAMILduInterfaceField
	TypeName ("cyclicAMILduInterfaceField")
	Runtime type information. More...

	cyclicAMILduInterfaceField ()
	Construct null. More...

virtual	~cyclicAMILduInterfaceField ()
	Destructor. More...

virtual bool	doTransform () const =0
	Is the transform required. More...

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

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

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

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

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

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

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

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

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

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

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

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

virtual tmp< Field< scalar > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient. More...

virtual tmp< Field< scalar > >	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< scalar > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

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

virtual tmp< Field< scalar > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

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

virtual tmp< Field< scalar > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

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

Public Member Functions inherited from LduInterfaceField< scalar >
	LduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

	TypeName ("LduInterfaceField")
	Runtime type information. More...

virtual	~LduInterfaceField ()
	Destructor. More...

virtual void	initInterfaceMatrixUpdate (Field< scalar > &, const Field< scalar > &, const scalarField &, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. 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...

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

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

Public Member Functions inherited from fvPatchField< scalar >
	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 DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. 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...

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	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. 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 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 &)

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

Static Public Member Functions inherited from fvPatchField< scalar >
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< scalar >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Protected Attributes inherited from fixedJumpAMIFvPatchField< scalar >
Field< scalar >	jump_
	"jump" field More...

Detailed Description

This boundary condition provides an energy jump condition across a pair of coupled patches with an arbitrary mesh interface (AMI). It is not applied directly, but is employed on-the-fly when converting temperature boundary conditions into energy.

See also: Foam::fixedJumpAMIFvPatchField

Source files

Definition at line 57 of file energyJumpAMIFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ energyJumpAMIFvPatchScalarField() [1/5]

energyJumpAMIFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 34 of file energyJumpAMIFvPatchScalarField.C.

Referenced by energyJumpAMIFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ energyJumpAMIFvPatchScalarField() [2/5]

energyJumpAMIFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 56 of file energyJumpAMIFvPatchScalarField.C.

References dict, p, and scalarField().

Here is the call graph for this function:

◆ energyJumpAMIFvPatchScalarField() [3/5]

energyJumpAMIFvPatchScalarField	(	const energyJumpAMIFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given energyJumpAMIFvPatchScalarField onto a.

new patch

Definition at line 44 of file energyJumpAMIFvPatchScalarField.C.

◆ energyJumpAMIFvPatchScalarField() [4/5]

energyJumpAMIFvPatchScalarField ( const energyJumpAMIFvPatchScalarField & ptf )

Construct as copy.

Definition at line 79 of file energyJumpAMIFvPatchScalarField.C.

◆ energyJumpAMIFvPatchScalarField() [5/5]

energyJumpAMIFvPatchScalarField	(	const energyJumpAMIFvPatchScalarField &	ptf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 88 of file energyJumpAMIFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "energyJumpAMI" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Definition at line 101 of file energyJumpAMIFvPatchScalarField.H.

References energyJumpAMIFvPatchScalarField::energyJumpAMIFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedJumpAMIFvPatchField< scalar >.

Definition at line 118 of file energyJumpAMIFvPatchScalarField.H.

References energyJumpAMIFvPatchScalarField::energyJumpAMIFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients.

Reimplemented from fvPatchField< scalar >.

Definition at line 99 of file energyJumpAMIFvPatchScalarField.C.

References cyclicAMIFvPatchField< scalar >::cyclicAMIPatch(), fvPatch::faceCells(), basicThermo::he(), fvPatch::index(), fixedJumpAMIFvPatchField< scalar >::jump_, basicThermo::lookupThermo(), fvPatchField< scalar >::patch(), fvPatchField< Type >::updateCoeffs(), and fvPatchField< scalar >::updated().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedJumpAMIFvPatchField< scalar >.

Definition at line 133 of file energyJumpAMIFvPatchScalarField.C.

References fixedJumpAMIFvPatchField< Type >::write().

Here is the call graph for this function:

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

src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H
src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ energyJumpAMIFvPatchScalarField() [1/5]

◆ energyJumpAMIFvPatchScalarField() [2/5]

◆ energyJumpAMIFvPatchScalarField() [3/5]

◆ energyJumpAMIFvPatchScalarField() [4/5]

◆ energyJumpAMIFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()