Public Member Functions | List of all members
singleSizeGroupFvScalarFieldSource Class Reference

Source 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 singleSizeGroupFvScalarFieldSource:
Inheritance graph
[legend]
Collaboration diagram for singleSizeGroupFvScalarFieldSource:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("singleSizeGroup")
 Runtime type information. More...
 
 singleSizeGroupFvScalarFieldSource (const DimensionedField< scalar, volMesh > &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 singleSizeGroupFvScalarFieldSource (const singleSizeGroupFvScalarFieldSource &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual autoPtr< fvScalarFieldSource > clone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~singleSizeGroupFvScalarFieldSource ()
 Destructor. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > sourceValue (const fvSource &model, const DimensionedField< scalar, volMesh > &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, volMesh > > internalCoeff (const fvSource &model, const DimensionedField< scalar, volMesh > &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...
 

Detailed Description

Source 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 source condition specification: 
<sourceName>
{
    type        singleSizeGroup;
    index       0;
}
Source files

Definition at line 60 of file singleSizeGroupFvScalarFieldSource.H.

Constructor & Destructor Documentation

◆ singleSizeGroupFvScalarFieldSource() [1/2]

singleSizeGroupFvScalarFieldSource ( const DimensionedField< scalar, volMesh > &  iF,
const dictionary &  dict 
)

Construct from internal field and dictionary.

Definition at line 55 of file singleSizeGroupFvScalarFieldSource.C.

◆ singleSizeGroupFvScalarFieldSource() [2/2]

singleSizeGroupFvScalarFieldSource ( const singleSizeGroupFvScalarFieldSource &  field,
const DimensionedField< scalar, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 66 of file singleSizeGroupFvScalarFieldSource.C.

◆ ~singleSizeGroupFvScalarFieldSource()

~singleSizeGroupFvScalarFieldSource ( )
virtual

Destructor.

Definition at line 79 of file singleSizeGroupFvScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "singleSizeGroup"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 101 of file singleSizeGroupFvScalarFieldSource.H.

◆ sourceValue() [1/2]

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

Return the source value.

Definition at line 86 of file singleSizeGroupFvScalarFieldSource.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 103 of file singleSizeGroupFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

◆ internalCoeff() [1/2]

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

Return the internal coefficient.

Definition at line 115 of file singleSizeGroupFvScalarFieldSource.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 132 of file singleSizeGroupFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 143 of file singleSizeGroupFvScalarFieldSource.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: