Public Member Functions | List of all members
internalFvFieldSource< Type > Class Template Reference

This source condition provides the internal value. More...

Inheritance diagram for internalFvFieldSource< Type >:
Inheritance graph
[legend]
Collaboration diagram for internalFvFieldSource< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("internal")
 Runtime type information. More...
 
 internalFvFieldSource (const DimensionedField< Type, volMesh > &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 internalFvFieldSource (const internalFvFieldSource< Type > &, const DimensionedField< Type, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual autoPtr< fvFieldSource< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~internalFvFieldSource ()
 Destructor. More...
 
virtual tmp< Field< Type > > sourceValue (const fvSource &) const
 Return the source value. More...
 
virtual tmp< scalarField > internalCoeff (const fvSource &) const
 Return the internal coefficient. More...
 
- Public Member Functions inherited from fvFieldSource< Type >
 TypeName ("fvFieldSource")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvFieldSource, null,(const DimensionedField< Type, volMesh > &iF),(iF))
 Select given internal field. More...
 
 declareRunTimeSelectionTable (autoPtr, fvFieldSource, dictionary,(const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(iF, dict))
 Select given internal field and dictionary. More...
 
 fvFieldSource (const DimensionedField< Type, volMesh > &)
 Construct from internal field. More...
 
 fvFieldSource (const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from internal field and dictionary. More...
 
 fvFieldSource (const fvFieldSource< Type > &)=delete
 Disallow copy without setting internal field reference. More...
 
autoPtr< fvFieldSource< Type > > clone () const
 Disallow clone without setting internal field reference. More...
 
 fvFieldSource (const fvFieldSource< Type > &, const DimensionedField< Type, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual ~fvFieldSource ()
 Destructor. More...
 
const objectRegistry & db () const
 Return the local object registry. More...
 
const DimensionedField< Type, volMesh > & internalField () const
 Return the internal field reference. More...
 
tmp< Field< Type > > sourceCoeff (const fvSource &) const
 Return the source coefficient. More...
 
tmp< Field< Type > > value (const fvSource &) const
 Return the value. More...
 
template<class OtherType >
const fvFieldSource< OtherType > & fieldSource (const word &name, const fvSource &) const
 Lookup and return another field source. More...
 
template<class OtherType >
tmp< Field< OtherType > > value (const word &name, const fvSource &) const
 Lookup and return the value of another field source. More...
 
virtual void write (Ostream &) const
 Write. More...
 
template<class OtherType >
const Foam::fvFieldSource< OtherType > & fieldSource (const word &name, const fvSource &source) const
 
template<class OtherType >
Foam::tmp< Foam::Field< OtherType > > value (const word &name, const fvSource &source) const
 

Additional Inherited Members

- Static Public Member Functions inherited from fvFieldSource< Type >
static autoPtr< fvFieldSource< Type > > New (const word &fieldSourceType, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new field source. More...
 
static autoPtr< fvFieldSource< Type > > New (const DimensionedField< Type, volMesh > &, const dictionary &)
 Return a pointer to a new field source created from a dictionary. More...
 
- Static Public Attributes inherited from fvFieldSource< Type >
static int disallowGenericFvFieldSource
 Debug switch to disallow the use of genericFvFieldSource. More...
 

Detailed Description

template<class Type>
class Foam::internalFvFieldSource< Type >

This source condition provides the internal value.

Usage
Example of the source condition specification: 
<patchName>
{
    type            internal;
}
Source files

Definition at line 58 of file internalFvFieldSource.H.

Constructor & Destructor Documentation

◆ internalFvFieldSource() [1/2]

internalFvFieldSource ( const DimensionedField< Type, volMesh > &  iF,
const dictionary &  dict 
)

Construct from internal field and dictionary.

Definition at line 31 of file internalFvFieldSource.C.

◆ internalFvFieldSource() [2/2]

internalFvFieldSource ( const internalFvFieldSource< Type > &  field,
const DimensionedField< Type, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 42 of file internalFvFieldSource.C.

◆ ~internalFvFieldSource()

~internalFvFieldSource
virtual

Destructor.

Definition at line 55 of file internalFvFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "internal"  )

Runtime type information.

◆ clone()

virtual autoPtr<fvFieldSource<Type> > clone ( const DimensionedField< Type, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Implements fvFieldSource< Type >.

Definition at line 85 of file internalFvFieldSource.H.

◆ sourceValue()

Foam::tmp< Foam::Field< Type > > sourceValue ( const fvSource &  source) const
virtual

Return the source value.

Implements fvFieldSource< Type >.

Definition at line 63 of file internalFvFieldSource.C.

References fvSource::cells().

Here is the call graph for this function:

◆ internalCoeff()

Foam::tmp< Foam::scalarField > internalCoeff ( const fvSource &  source) const
virtual

Return the internal coefficient.

Implements fvFieldSource< Type >.

Definition at line 79 of file internalFvFieldSource.C.

References fvSource::nCells().

Here is the call graph for this function:
The documentation for this class was generated from the following files: