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

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

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

Public Member Functions

 TypeName ("internal")
 Runtime type information. More...
 
virtual autoPtr< LagrangianFieldSource< Type > > clone (const regIOobject &iIo) const
 Construct and return a clone setting the internal field reference. More...
 
virtual ~internalLagrangianFieldSource ()
 Destructor. More...
 
virtual tmp< LagrangianSubField< Type > > sourceValue (const LagrangianSource &, const LagrangianSubMesh &) const
 Return the source value. More...
 
virtual tmp< LagrangianSubScalarField > internalCoeff (const LagrangianSource &, const LagrangianSubMesh &) const
 Return the internal coefficient. More...
 
- Public Member Functions inherited from LagrangianFieldSource< Type >
 TypeName ("LagrangianFieldSource")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianFieldSource, null,(const regIOobject &iIo),(iIo))
 Select given internal field. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianFieldSource, dictionary,(const regIOobject &iIo, const dictionary &dict),(iIo, dict))
 Select given internal field and dictionary. More...
 
 LagrangianFieldSource (const regIOobject &)
 Construct from internal field. More...
 
 LagrangianFieldSource (const regIOobject &, const dictionary &)
 Construct from internal field and dictionary. More...
 
 LagrangianFieldSource (const LagrangianFieldSource< Type > &)=delete
 Disallow copy without setting the internal field reference. More...
 
autoPtr< LagrangianFieldSource< Type > > clone () const
 Disallow clone without setting the internal field reference. More...
 
 LagrangianFieldSource (const LagrangianFieldSource< Type > &, const regIOobject &)
 Construct as copy setting the internal field reference. More...
 
virtual ~LagrangianFieldSource ()
 Destructor. More...
 
virtual const dimensionSet & internalDimensions () const
 Return internal dimensions reference. More...
 
const LagrangianInternalDynamicField< Type > & internalField () const
 Return internal field reference. More...
 
tmp< LagrangianSubField< Type > > sourceCoeff (const LagrangianSource &, const LagrangianSubMesh &) const
 Return the source coefficient. More...
 
tmp< LagrangianSubField< Type > > value (const LagrangianSource &, const LagrangianSubMesh &) const
 Return the value for a continuous source. More...
 
virtual tmp< LagrangianSubField< Type > > value (const LagrangianInjection &, const LagrangianSubMesh &) const
 Return the value for an instantaneous injection. More...
 
virtual tmp< LagrangianSubField< Type > > value (const LagrangianSubMesh &) const
 Return the value without a model. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from LagrangianFieldSourceBase
 TypeName ("LagrangianFieldSourceBase")
 Runtime type information. More...
 
 LagrangianFieldSourceBase (const regIOobject &)
 Construct from internal field. More...
 
virtual ~LagrangianFieldSourceBase ()
 Destructor. More...
 
const objectRegistry & db () const
 Return local objectRegistry. More...
 
const Time & time () const
 Return time. More...
 
const word & internalName () const
 Return internal field name. More...
 
word internalGroup () const
 Return internal field group. More...
 
template<class OtherFieldSourceType >
const OtherFieldSourceType & fieldSourceCast (const LagrangianModel &) const
 Cast a to the specified type. Handle errors. More...
 
template<class OtherType >
const LagrangianFieldSource< OtherType > & fieldSource (const word &name, const LagrangianModel &) const
 Lookup and return another field source. More...
 
template<class OtherType , class OtherFieldSourceType >
const OtherFieldSourceType & fieldSourceCast (const word &name, const LagrangianModel &) const
 Lookup and return another field source and then cast to a. More...
 
template<class OtherModelType >
const OtherModelType & modelCast (const LagrangianModel &) const
 Cast a model to the specified type. Handle errors. More...
 
template<class OtherType >
tmp< LagrangianSubField< OtherType > > value (const word &name, const LagrangianSource &, const LagrangianSubMesh &) const
 Lookup and return the value of another field source. More...
 
template<class OtherType >
tmp< LagrangianSubField< OtherType > > value (const word &name, const LagrangianInjection &, const LagrangianSubMesh &) const
 Lookup and return the value of another field source. More...
 
template<class OtherType >
const Foam::LagrangianFieldSource< OtherType > & fieldSource (const word &name, const LagrangianModel &model) const
 
template<class OtherType >
Foam::tmp< Foam::LagrangianSubField< OtherType > > value (const word &name, const LagrangianSource &source, const LagrangianSubMesh &subMesh) const
 
template<class OtherType >
Foam::tmp< Foam::LagrangianSubField< OtherType > > value (const word &name, const LagrangianInjection &injection, const LagrangianSubMesh &subMesh) const
 

Additional Inherited Members

- Static Public Member Functions inherited from LagrangianFieldSource< Type >
static autoPtr< LagrangianFieldSource< Type > > New (const word &fieldSourceType, const regIOobject &)
 Return a pointer to a new field source. More...
 
static autoPtr< LagrangianFieldSource< Type > > New (const regIOobject &, const dictionary &)
 Return a pointer to a new field source created from a dictionary. More...
 
- Static Public Attributes inherited from LagrangianFieldSource< Type >
static int disallowGenericLagrangianFieldSource
 Debug switch to disallow the use of genericLagrangianFieldSource. More...
 
- Protected Attributes inherited from LagrangianFieldSourceBase
const regIOobject & internalIo_
 Reference to the internal IO object. More...
 

Detailed Description

template<class Type>
class Foam::internalLagrangianFieldSource< Type >

This source condition retains the internal value.

Usage
Example specification: 
<LagrangianModelName>
{
    type            internal;
}
Source files

Definition at line 58 of file internalLagrangianFieldSource.H.

Constructor & Destructor Documentation

◆ ~internalLagrangianFieldSource()

~internalLagrangianFieldSource
virtual

Destructor.

Definition at line 31 of file internalLagrangianFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "internal"  )

Runtime type information.

◆ clone()

virtual autoPtr<LagrangianFieldSource<Type> > clone ( const regIOobject &  iIo) const
inlinevirtual

Construct and return a clone setting the internal field reference.

Implements LagrangianFieldSource< Type >.

Definition at line 74 of file internalLagrangianFieldSource.H.

◆ sourceValue()

Foam::tmp< Foam::LagrangianSubField< Type > > sourceValue ( const LagrangianSource &  source,
const LagrangianSubMesh &  subMesh 
) const
virtual

Return the source value.

Reimplemented from LagrangianFieldSource< Type >.

Definition at line 39 of file internalLagrangianFieldSource.C.

References LagrangianModel::name(), Foam::name(), Foam::New(), and LagrangianSubMesh::sub().

Here is the call graph for this function:

◆ internalCoeff()

Foam::tmp< Foam::LagrangianSubScalarField > internalCoeff ( const LagrangianSource &  source,
const LagrangianSubMesh &  subMesh 
) const
virtual

Return the internal coefficient.

Reimplemented from LagrangianFieldSource< Type >.

Definition at line 56 of file internalLagrangianFieldSource.C.

References Foam::dimensions::dimless, LagrangianModel::name(), Foam::name(), and Foam::New().

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