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

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

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

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

	energyJumpAMIFvPatchScalarField (const energyJumpAMIFvPatchScalarField &)

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

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

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

virtual void	updateCoeffs ()

virtual void	write (Ostream &) const

Public Member Functions inherited from fixedJumpAMIFvPatchField< scalar >
	TypeName ("fixedJumpAMI")

	fixedJumpAMIFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)

	fixedJumpAMIFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)

	fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

	fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< scalar > &)

	fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)

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

virtual tmp< Field< scalar > >	jump () const

virtual void	autoMap (const fvPatchFieldMapper &)

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

Public Member Functions inherited from jumpCyclicAMIFvPatchField< scalar >
	TypeName ("jumpCyclicAMI")

	jumpCyclicAMIFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)

	jumpCyclicAMIFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)

	jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

	jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< scalar > &)

	jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)

virtual const word &	interfaceFieldType () const

tmp< Field< scalar > >	patchNeighbourField () 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	updateInterfaceMatrix (Field< scalar > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< scalar > &, const scalarField &, const Pstream::commsTypes commsType) const

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

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

Public Member Functions inherited from cyclicAMIFvPatchField< scalar >
	TypeName (cyclicAMIFvPatch::typeName_())

	cyclicAMIFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)

	cyclicAMIFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< scalar > &)

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)

const cyclicAMIFvPatch &	cyclicAMIPatch () const

virtual bool	coupled () const

const cyclicAMIFvPatchField< scalar > &	neighbourPatchField () const

virtual void	manipulateMatrix (fvMatrix< scalar > &m, const label iMatrix, const direction cmpt)

virtual bool	doTransform () const

virtual const tensorField &	forwardT () const

virtual const tensorField &	reverseT () const

virtual int	rank () const

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

	cyclicAMILduInterfaceField ()

virtual	~cyclicAMILduInterfaceField ()

virtual bool	doTransform () const =0

virtual const tensorField &	forwardT () const =0

virtual const tensorField &	reverseT () const =0

virtual int	rank () const =0

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

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

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

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

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

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

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

	coupledFvPatchField (const coupledFvPatchField< scalar > &)

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

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

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

virtual void	initEvaluate (const Pstream::commsTypes commsType)

virtual void	evaluate (const Pstream::commsTypes commsType)

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

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

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

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

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

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

Public Member Functions inherited from LduInterfaceField< scalar >
	LduInterfaceField (const lduInterface &patch)

	TypeName ("LduInterfaceField")

virtual	~LduInterfaceField ()=default

virtual void	initInterfaceMatrixUpdate (Field< scalar > &, const bool add, const lduAddressing &, const label interfacei, const Field< scalar > &, const scalarField &, const Pstream::commsTypes commsType) const

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

virtual bool	ready () const

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

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< scalar >
	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 DimensionedField< Type, volMesh > &iF) 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

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	rmap (const fvPatchField< Type > &, const labelList &)

virtual void	updateWeightedCoeffs (const scalarField &weights)

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

virtual void	patchInternalField (Field< Type > &) const

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

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) 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< scalar >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< scalar >
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< scalar >
static int	disallowGenericFvPatchField

Protected Attributes inherited from fixedJumpAMIFvPatchField< scalar >
Field< scalar >	jump_

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 55 of file energyJumpAMIFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ energyJumpAMIFvPatchScalarField() [1/5]

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

Definition at line 29 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
	)

Definition at line 51 of file energyJumpAMIFvPatchScalarField.C.

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

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
	)

Definition at line 39 of file energyJumpAMIFvPatchScalarField.C.

◆ energyJumpAMIFvPatchScalarField() [4/5]

energyJumpAMIFvPatchScalarField ( const energyJumpAMIFvPatchScalarField & ptf )

Definition at line 74 of file energyJumpAMIFvPatchScalarField.C.

◆ energyJumpAMIFvPatchScalarField() [5/5]

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

Definition at line 83 of file energyJumpAMIFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "energyJumpAMI" )

◆ clone() [1/2]

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

inlinevirtual

Definition at line 99 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

Reimplemented from fixedJumpAMIFvPatchField< scalar >.

Definition at line 116 of file energyJumpAMIFvPatchScalarField.H.

References energyJumpAMIFvPatchScalarField::energyJumpAMIFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Reimplemented from fvPatchField< scalar >.

Definition at line 94 of file energyJumpAMIFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedJumpAMIFvPatchField< scalar >.

Definition at line 128 of file energyJumpAMIFvPatchScalarField.C.

References os(), and 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()