singleSizeGroupFvPatchScalarField Class Reference

Boundary condition for size-group fractions 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 singleSizeGroupFvPatchScalarField:
Collaboration diagram for singleSizeGroupFvPatchScalarField:

Public Member Functions

 TypeName ("singleSizeGroup")
 Runtime type information. More...
 
 singleSizeGroupFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 singleSizeGroupFvPatchScalarField (const singleSizeGroupFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given fixedValueTypeFvPatchField. More...
 
 singleSizeGroupFvPatchScalarField (const singleSizeGroupFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 singleSizeGroupFvPatchScalarField (const singleSizeGroupFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &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...
 

Detailed Description

Boundary condition for size-group fractions 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        singleSizeGroup;
    index       0;
    value       $internalField;
}
Source files

Definition at line 61 of file singleSizeGroupFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ singleSizeGroupFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 32 of file singleSizeGroupFvPatchScalarField.C.

◆ singleSizeGroupFvPatchScalarField() [2/4]

singleSizeGroupFvPatchScalarField ( const singleSizeGroupFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const fieldMapper mapper 
)

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 44 of file singleSizeGroupFvPatchScalarField.C.

◆ singleSizeGroupFvPatchScalarField() [3/4]

Disallow copy without setting internal field reference.

◆ singleSizeGroupFvPatchScalarField() [4/4]

Copy constructor setting internal field reference.

Definition at line 57 of file singleSizeGroupFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "singleSizeGroup"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 111 of file singleSizeGroupFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 70 of file singleSizeGroupFvPatchScalarField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, sizeGroup::group(), sizeGroup::i(), Foam::operator==(), and velocityGroup::sizeGroups().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 98 of file singleSizeGroupFvPatchScalarField.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: