FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

NoInjection< CloudType > Class Template Reference

Place holder for 'none' option. More...

#include <lagrangianIntermediate/NoInjection.H>


Detailed Description

template<class CloudType>
class Foam::NoInjection< CloudType >

Place holder for 'none' option.

Source files

Definition at line 50 of file NoInjection.H.

Inheritance diagram for NoInjection< CloudType >:
Collaboration diagram for NoInjection< CloudType >:

List of all members.

Public Member Functions

 TypeName ("none")
 Runtime type information.
 NoInjection (const dictionary &, CloudType &)
 Construct from components.
virtual  ~NoInjection ()
 Destructor.
bool  active () const
 Flag to indicate whether model activates injection model.
scalar  timeEnd () const
 Return the end-of-injection time.
virtual void  setPositionAndCell (const label parcelI, const label nParcels, const scalar time, vector &position, label &cellOwner)
 Set the injection position and owner cell.
virtual void  setProperties (const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel)
 Set the parcel properties.
virtual bool  fullyDescribed () const
 Flag to identify whether model fully describes the parcel.
virtual bool  validInjection (const label parcelI)
 Return flag to identify whether or not injection of parcelI is.

Protected Member Functions

label  parcelsToInject (const scalar, const scalar) const
 Number of parcels to introduce over the time step relative to SOI.
scalar  volumeToInject (const scalar, const scalar) const
 Volume of parcels to introduce over the time step relative to SOI.

Constructor & Destructor Documentation

NoInjection ( const dictionary &   ,
CloudType &   owner  
)

Construct from components.

Definition at line 57 of file NoInjection.C.

~NoInjection (  ) [virtual]

Destructor.

Definition at line 69 of file NoInjection.C.


Member Function Documentation

Foam::label parcelsToInject ( const   scalar,
const   scalar  
) const [protected, virtual]

Number of parcels to introduce over the time step relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 33 of file NoInjection.C.

Foam::scalar volumeToInject ( const   scalar,
const   scalar  
) const [protected, virtual]

Volume of parcels to introduce over the time step relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 44 of file NoInjection.C.

TypeName ( "none"    )

Runtime type information.

bool active (  ) const [virtual]

Flag to indicate whether model activates injection model.

Implements InjectionModel< CloudType >.

Definition at line 76 of file NoInjection.C.

Foam::scalar timeEnd (  ) const [virtual]

Return the end-of-injection time.

Implements InjectionModel< CloudType >.

Definition at line 83 of file NoInjection.C.

void setPositionAndCell ( const label   parcelI,
const label   nParcels,
const scalar   time,
vector &   position,
label &   cellOwner  
) [virtual]

Set the injection position and owner cell.

Implements InjectionModel< CloudType >.

Definition at line 91 of file NoInjection.C.

void setProperties ( const label   parcelI,
const label   nParcels,
const scalar   time,
typename CloudType::parcelType &   parcel  
) [virtual]

Set the parcel properties.

Implements InjectionModel< CloudType >.

Definition at line 103 of file NoInjection.C.

bool fullyDescribed (  ) const [virtual]

Flag to identify whether model fully describes the parcel.

Implements InjectionModel< CloudType >.

Definition at line 119 of file NoInjection.C.

bool validInjection ( const label   parcelI  ) [virtual]

Return flag to identify whether or not injection of parcelI is.

permitted

Implements InjectionModel< CloudType >.

Definition at line 126 of file NoInjection.C.


The documentation for this class was generated from the following files:
  • src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.H
  • src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.C