singleGroupFractionFvScalarFieldSource Class Reference

Source condition for group fractions of a population balance model that sets a value of one in a single group, identified by its index, and a value of zero in all other groups. More...

Inheritance diagram for singleGroupFractionFvScalarFieldSource:

Collaboration diagram for singleGroupFractionFvScalarFieldSource:

Public Member Functions
	TypeName ("singleGroupFraction")
	Runtime type information. More...
	singleGroupFractionFvScalarFieldSource (const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
	Construct from internal field and dictionary. More...
	singleGroupFractionFvScalarFieldSource (const singleGroupFractionFvScalarFieldSource &, const DimensionedField< scalar, fvMesh > &)
	Copy constructor setting internal field reference. More...
virtual autoPtr< fvScalarFieldSource >	clone (const DimensionedField< scalar, fvMesh > &iF) const
	Construct and return a clone setting internal field reference. More...
virtual	~singleGroupFractionFvScalarFieldSource ()
	Destructor. More...
virtual tmp< DimensionedField< scalar, fvMesh > >	sourceValue (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
	Return the source value. More...
virtual tmp< scalarField >	sourceValue (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the source value. More...
virtual tmp< DimensionedField< scalar, fvMesh > >	internalCoeff (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
	Return the internal coefficient. More...
virtual tmp< scalarField >	internalCoeff (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the internal coefficient. More...
virtual void	write (Ostream &) const
	Write. More...
Public Member Functions inherited from groupPropertyFvScalarField
	groupPropertyFvScalarField (const DimensionedField< scalar, fvMesh > &)
	Construct from internal field. More...
const populationBalanceModel &	popBal () const
	Return the population balance. More...
label	i () const
	Return the index of this group. More...

Detailed Description

Source condition for group fractions of a population balance model that sets a value of one in a single group, identified by its index, and a value of zero in all other groups.

Usage

Example of the source condition specification:

<sourceName>
{
    type        singleGroupFraction;
    index       0;
}

Source files

• singleGroupFractionFvScalarFieldSource.H
• singleGroupFractionFvScalarFieldSource.C

Definition at line 61 of file singleGroupFractionFvScalarFieldSource.H.

Constructor & Destructor Documentation

singleGroupFractionFvScalarFieldSource() [1/2]

singleGroupFractionFvScalarFieldSource	(	const DimensionedField< scalar, fvMesh > &	iF,
		const dictionary &	dict
	)

Construct from internal field and dictionary.

Definition at line 39 of file singleGroupFractionFvScalarFieldSource.C.

singleGroupFractionFvScalarFieldSource() [2/2]

singleGroupFractionFvScalarFieldSource	(	const singleGroupFractionFvScalarFieldSource &	field,
		const DimensionedField< scalar, fvMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 52 of file singleGroupFractionFvScalarFieldSource.C.

~singleGroupFractionFvScalarFieldSource()

~singleGroupFractionFvScalarFieldSource ( )

virtual

Destructor.

Definition at line 67 of file singleGroupFractionFvScalarFieldSource.C.

Member Function Documentation

TypeName()

TypeName

(

"singleGroupFraction"

)

Runtime type information.

clone()

virtual autoPtr<fvScalarFieldSource> clone ( const DimensionedField< scalar, fvMesh > &  iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 103 of file singleGroupFractionFvScalarFieldSource.H.

sourceValue() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::fvMesh > > sourceValue ( const fvSource &  model, const DimensionedField< scalar, fvMesh > &  source  ) const

virtual

Return the source value.

Definition at line 75 of file singleGroupFractionFvScalarFieldSource.C.

References Foam::dimless, fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

sourceValue() [2/2]

Foam::tmp< Foam::scalarField > sourceValue ( const fvSource &  model, const scalarField &  source, const labelUList &  cells  ) const

virtual

Return the source value.

Definition at line 92 of file singleGroupFractionFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

internalCoeff() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::fvMesh > > internalCoeff ( const fvSource &  model, const DimensionedField< scalar, fvMesh > &  source  ) const

virtual

Return the internal coefficient.

Definition at line 104 of file singleGroupFractionFvScalarFieldSource.C.

References Foam::dimless, fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

internalCoeff() [2/2]

Foam::tmp< Foam::scalarField > internalCoeff ( const fvSource &  model, const scalarField &  source, const labelUList &  cells  ) const

virtual

Return the internal coefficient.

Definition at line 121 of file singleGroupFractionFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Definition at line 132 of file singleGroupFractionFvScalarFieldSource.C.

References Foam::vtkWriteOps::write(), and Foam::writeEntry().

Here is the call graph for this function:

---

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

• applications/modules/multiphaseEuler/populationBalance/derivedFvFieldSources/singleGroupFraction/singleGroupFractionFvScalarFieldSource.H
• applications/modules/multiphaseEuler/populationBalance/derivedFvFieldSources/singleGroupFraction/singleGroupFractionFvScalarFieldSource.C