Public Member Functions | Protected Attributes | List of all members
LagrangianFieldSourceBase Class Referenceabstract

Base class for Lagrangian source conditions. More...

Inheritance diagram for LagrangianFieldSourceBase:
Inheritance graph
[legend]
Collaboration diagram for LagrangianFieldSourceBase:
Collaboration graph
[legend]

Public Member Functions

 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...
 
virtual const dimensionSet & internalDimensions () const =0
 Return internal dimensions reference. 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
 

Protected Attributes

const regIOobject & internalIo_
 Reference to the internal IO object. More...
 

Detailed Description

Base class for Lagrangian source conditions.

Source files

Definition at line 60 of file LagrangianFieldSourceBase.H.

Constructor & Destructor Documentation

◆ LagrangianFieldSourceBase()

LagrangianFieldSourceBase ( const regIOobject &  iIo)

Construct from internal field.

Definition at line 38 of file LagrangianFieldSourceBase.C.

◆ ~LagrangianFieldSourceBase()

~LagrangianFieldSourceBase ( )
virtual

Destructor.

Definition at line 49 of file LagrangianFieldSourceBase.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LagrangianFieldSourceBase"  )

Runtime type information.

◆ db()

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 55 of file LagrangianFieldSourceBase.C.

References objectRegistry::db().

Referenced by LagrangianFieldSourceBase::fieldSourceCast().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ time()

const Foam::Time & time ( ) const

Return time.

Definition at line 61 of file LagrangianFieldSourceBase.C.

References objectRegistry::db(), and objectRegistry::time().

Here is the call graph for this function:

◆ internalName()

const Foam::word & internalName ( ) const

Return internal field name.

Definition at line 67 of file LagrangianFieldSourceBase.C.

Referenced by LagrangianFieldSourceBase::fieldSourceCast().

Here is the caller graph for this function:

◆ internalGroup()

Foam::word internalGroup ( ) const

Return internal field group.

Definition at line 73 of file LagrangianFieldSourceBase.C.

◆ internalDimensions()

virtual const dimensionSet& internalDimensions ( ) const
pure virtual

Return internal dimensions reference.

Implemented in LagrangianFieldSource< Type >.

Referenced by Function1LagrangianFieldSource::value().

Here is the caller graph for this function:

◆ fieldSourceCast() [1/2]

const OtherFieldSourceType & fieldSourceCast ( const LagrangianModel &  model) const

Cast a to the specified type. Handle errors.

Definition at line 33 of file LagrangianFieldSourceBaseTemplates.C.

References LagrangianFieldSourceBase::db(), objectRegistry::dbDir(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianFieldSourceBase::internalIo_, LagrangianFieldSourceBase::internalName(), LagrangianModel::name(), IOobject::name(), Foam::type(), and Foam::typeName().

Here is the call graph for this function:

◆ fieldSource() [1/2]

const LagrangianFieldSource<OtherType>& fieldSource ( const word &  name,
const LagrangianModel &   
) const

Lookup and return another field source.

◆ fieldSourceCast() [2/2]

const OtherFieldSourceType & fieldSourceCast ( const word &  name,
const LagrangianModel &  model 
) const

Lookup and return another field source and then cast to a.

specified type. Handle errors.

Definition at line 71 of file LagrangianFieldSourceBaseTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianModel::name(), Foam::name(), Foam::type(), and Foam::typeName().

Here is the call graph for this function:

◆ modelCast()

const OtherModelType & modelCast ( const LagrangianModel &  model) const

Cast a model to the specified type. Handle errors.

Definition at line 98 of file LagrangianFieldSourceBaseTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianModel::name(), Foam::type(), and Foam::typeName().

Here is the call graph for this function:

◆ value() [1/4]

tmp<LagrangianSubField<OtherType> > value ( const word &  name,
const LagrangianSource &  ,
const LagrangianSubMesh &   
) const

Lookup and return the value of another field source.

◆ value() [2/4]

tmp<LagrangianSubField<OtherType> > value ( const word &  name,
const LagrangianInjection &  ,
const LagrangianSubMesh &   
) const

Lookup and return the value of another field source.

◆ fieldSource() [2/2]

const Foam::LagrangianFieldSource<OtherType>& fieldSource ( const word &  name,
const LagrangianModel &  model 
) const

Definition at line 57 of file LagrangianFieldSourceBaseTemplates.C.

References LagrangianModel::name(), Foam::name(), and GeometricField< Type, GeoMesh, PrimitiveField >::sources().

Here is the call graph for this function:

◆ value() [3/4]

Foam::tmp<Foam::LagrangianSubField<OtherType> > value ( const word &  name,
const LagrangianSource &  source,
const LagrangianSubMesh &  subMesh 
) const

Definition at line 120 of file LagrangianFieldSourceBaseTemplates.C.

References Foam::name().

Here is the call graph for this function:

◆ value() [4/4]

Foam::tmp<Foam::LagrangianSubField<OtherType> > value ( const word &  name,
const LagrangianInjection &  injection,
const LagrangianSubMesh &  subMesh 
) const

Definition at line 133 of file LagrangianFieldSourceBaseTemplates.C.

References Foam::name().

Here is the call graph for this function:

Member Data Documentation

◆ internalIo_

const regIOobject& internalIo_
protected

Reference to the internal IO object.

Definition at line 67 of file LagrangianFieldSourceBase.H.

Referenced by LagrangianFieldSourceBase::fieldSourceCast().

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