This BC is used for species inlets. The diffusion and advection fluxes are considered to calculate the inlet value for the species The massFluxFraction sets the fraction of the flux of each particular species. More...

Inheritance diagram for totalFlowRateAdvectiveDiffusiveFvPatchScalarField:

[legend]

Collaboration diagram for totalFlowRateAdvectiveDiffusiveFvPatchScalarField:

[legend]

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

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

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

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

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

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

	totalFlowRateAdvectiveDiffusiveFvPatchScalarField (const totalFlowRateAdvectiveDiffusiveFvPatchScalarField &, 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	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

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

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

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

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

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

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

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

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

	mixedFvPatchField (const mixedFvPatchField< 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 bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual Field< scalar > &	refValue ()

virtual const Field< scalar > &	refValue () const

virtual Field< scalar > &	refGrad ()

virtual const Field< scalar > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

virtual tmp< Field< scalar > >	snGrad () const
	Return gradient at boundary. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	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
	Return the matrix diagonal coefficients corresponding to the. More...

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

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

virtual void	operator= (const fvPatchField< 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< 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< scalar > &)

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

virtual void	operator/= (const scalar)

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

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. 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 void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise the evaluation of the patch field. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) 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 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< Type > &)

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

virtual void	operator== (const Type &)

Private Attributes
word	phiName_
	Name of the flux transporting the field. More...

word	rhoName_
	Name of the density field used to normalise the mass flux. More...

scalar	massFluxFraction_
	Mass flux fraction. More...

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

Detailed Description

This BC is used for species inlets. The diffusion and advection fluxes are considered to calculate the inlet value for the species The massFluxFraction sets the fraction of the flux of each particular species.

Source files

Definition at line 51 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 38 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

Referenced by totalFlowRateAdvectiveDiffusiveFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 56 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

References dict, and p.

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [3/5]

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

Construct by mapping given.

totalFlowRateAdvectiveDiffusiveFvPatchScalarField onto a new patch

Definition at line 87 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [4/5]

totalFlowRateAdvectiveDiffusiveFvPatchScalarField ( const totalFlowRateAdvectiveDiffusiveFvPatchScalarField & tppsf )

Construct as copy.

Definition at line 103 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [5/5]

totalFlowRateAdvectiveDiffusiveFvPatchScalarField	(	const totalFlowRateAdvectiveDiffusiveFvPatchScalarField &	tppsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 115 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "totalFlowRateAdvectiveDiffusive" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Definition at line 108 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H.

References totalFlowRateAdvectiveDiffusiveFvPatchScalarField::totalFlowRateAdvectiveDiffusiveFvPatchScalarField().

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

Definition at line 126 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H.

References totalFlowRateAdvectiveDiffusiveFvPatchScalarField::totalFlowRateAdvectiveDiffusiveFvPatchScalarField().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 130 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

◆ rmap()

void rmap	(	const fvPatchScalarField &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 139 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< scalar >.

Definition at line 148 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

References fvPatch::boundaryMesh(), fvPatchField< scalar >::db(), fvPatch::deltaCoeffs(), fvPatchField< scalar >::dimensionedInternalField(), Foam::endl(), Foam::constant::atomic::group, IOobject::groupName(), Foam::gSum(), fvPatch::index(), Foam::Info, objectRegistry::lookupObject(), fvPatch::lookupPatchField(), Foam::mag(), fvPatch::magSf(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::massFluxFraction_, Foam::max(), fvBoundaryMesh::mesh(), fvPatch::name(), fvMesh::name(), fvPatchField< scalar >::patch(), phi, totalFlowRateAdvectiveDiffusiveFvPatchScalarField::phiName_, turbulenceModel::propertiesName, mixedFvPatchField< scalar >::refGrad(), mixedFvPatchField< scalar >::refValue(), fvPatchField< Type >::updateCoeffs(), fvPatchField< scalar >::updated(), and mixedFvPatchField< scalar >::valueFraction().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 202 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C.

References token::END_STATEMENT, Foam::nl, fvPatchField::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ phiName_

word phiName_

private

Name of the flux transporting the field.

Definition at line 58 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H.

Referenced by totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs().

◆ rhoName_

word rhoName_

private

Name of the density field used to normalise the mass flux.

if neccessary

Definition at line 62 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H.

◆ massFluxFraction_

scalar massFluxFraction_

private

Mass flux fraction.

Definition at line 65 of file totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H.

Referenced by totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs().

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

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/totalFlowRateAdvectiveDiffusive/totalFlowRateAdvectiveDiffusiveFvPatchScalarField.H
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/totalFlowRateAdvectiveDiffusive/totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [1/5]

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [2/5]

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [3/5]

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [4/5]

◆ totalFlowRateAdvectiveDiffusiveFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ phiName_

◆ rhoName_

◆ massFluxFraction_