singleGroupFractionFvPatchScalarField Class Reference

Boundary 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 singleGroupFractionFvPatchScalarField:
Collaboration diagram for singleGroupFractionFvPatchScalarField:

Public Member Functions

 TypeName ("singleGroupFraction")
 Runtime type information. More...
 
 singleGroupFractionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 singleGroupFractionFvPatchScalarField (const singleGroupFractionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
 Construct by mapping given fixedValueTypeFvPatchField. More...
 
 singleGroupFractionFvPatchScalarField (const singleGroupFractionFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 singleGroupFractionFvPatchScalarField (const singleGroupFractionFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. 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 groupPropertyFvScalarField
 groupPropertyFvScalarField (const DimensionedField< scalar, fvMesh > &)
 Construct from internal field. More...
 
const populationBalanceModelpopBal () const
 Return the population balance. More...
 
label i () const
 Return the index of this group. More...
 

Detailed Description

Boundary 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 boundary condition specification:
<patchName>
{
    type        singleGroupFraction;
    index       0;
    value       $internalField;
}
Source files

Definition at line 62 of file singleGroupFractionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ singleGroupFractionFvPatchScalarField() [1/4]

singleGroupFractionFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, fvMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 32 of file singleGroupFractionFvPatchScalarField.C.

◆ singleGroupFractionFvPatchScalarField() [2/4]

singleGroupFractionFvPatchScalarField ( const singleGroupFractionFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, fvMesh > &  iF,
const fieldMapper mapper 
)

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 46 of file singleGroupFractionFvPatchScalarField.C.

◆ singleGroupFractionFvPatchScalarField() [3/4]

Disallow copy without setting internal field reference.

◆ singleGroupFractionFvPatchScalarField() [4/4]

Copy constructor setting internal field reference.

Definition at line 61 of file singleGroupFractionFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "singleGroupFraction"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 113 of file singleGroupFractionFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 76 of file singleGroupFractionFvPatchScalarField.C.

References populationBalanceModel::diameters(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 104 of file singleGroupFractionFvPatchScalarField.C.

References fvPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:

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