Public Member Functions | Protected Types | List of all members
NoSurfaceFilm< CloudType > Class Template Reference
Lagrangian particle models » Submodels » Kinematic » Surface film

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

Inheritance diagram for NoSurfaceFilm< CloudType >:
[legend]
Collaboration diagram for NoSurfaceFilm< CloudType >:
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoSurfaceFilm (const dictionary &, CloudType &)
 Construct from dictionary. More...
 
 NoSurfaceFilm (const NoSurfaceFilm< CloudType > &dm)
 Construct copy. More...
 
virtual autoPtr< SurfaceFilmModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~NoSurfaceFilm ()
 Destructor. More...
 
virtual bool active () const
 Flag to indicate whether model activates the surface film model. More...
 
virtual bool transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
 Transfer parcel from cloud to surface film. More...
 
virtual void setParcelProperties (parcelType &p, const label filmCelli) const
 Set parcel properties. More...
 
virtual void info (Ostream &os)
 Write surface film info to stream. More...
 
- Public Member Functions inherited from SurfaceFilmModel< CloudType >
 TypeName ("surfaceFilmModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, SurfaceFilmModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 SurfaceFilmModel (CloudType &owner)
 Construct null from owner. More...
 
 SurfaceFilmModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 SurfaceFilmModel (const SurfaceFilmModel< CloudType > &sfm)
 Construct copy. More...
 
virtual ~SurfaceFilmModel ()
 Destructor. More...
 
const dimensionedVector & g () const
 Return gravitational acceleration constant. More...
 
label nParcelsTransferred () const
 Return const access to the number of parcels transferred to the. More...
 
label & nParcelsTransferred ()
 Return non-const access to the number of parcels transferred to. More...
 
label nParcelsInjected () const
 Return const access to the number of parcels injected from the. More...
 
label & nParcelsInjected ()
 Return non-const access to the number of parcels injected from. More...
 
template<class TrackCloudType >
void inject (TrackCloudType &cloud)
 Inject parcels into the cloud. More...
 

Protected Types

typedef CloudType::parcelType parcelType
 Convenience typedef for parcel type. More...
 
- Protected Types inherited from SurfaceFilmModel< CloudType >
typedef CloudType::parcelType parcelType
 Convenience typedef to the cloud's parcel type. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Protected Member Functions inherited from SurfaceFilmModel< CloudType >
virtual void cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)
 Cache the film fields in preparation for injection. More...
 
- Protected Attributes inherited from SurfaceFilmModel< CloudType >
const dimensionedVector & g_
 Gravitational acceleration constant. More...
 
label ejectedParcelType_
 Ejected parcel type label - id assigned to identify parcel for. More...
 
scalarList massParcelPatch_
 Parcel mass / patch face. More...
 
scalarList diameterParcelPatch_
 Parcel diameter / patch face. More...
 
List< vector > UFilmPatch_
 Film velocity / patch face. More...
 
scalarList rhoFilmPatch_
 Film density / patch face. More...
 
scalarListList deltaFilmPatch_
 Film height of all film patches / patch face. More...
 
label nParcelsTransferred_
 Number of parcels transferred to the film model. More...
 
label nParcelsInjected_
 Number of parcels injected from the film model. More...
 

Detailed Description

template<class CloudType>
class Foam::NoSurfaceFilm< CloudType >

Place holder for 'none' option.

Source files

Definition at line 54 of file NoSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType
protected

Convenience typedef for parcel type.

Definition at line 63 of file NoSurfaceFilm.H.

Constructor & Destructor Documentation

◆ NoSurfaceFilm() [1/2]

NoSurfaceFilm ( const dictionary &  ,
CloudType &  owner 
)

Construct from dictionary.

Definition at line 35 of file NoSurfaceFilm.C.

◆ NoSurfaceFilm() [2/2]

NoSurfaceFilm ( const NoSurfaceFilm< CloudType > &  dm)

Construct copy.

Definition at line 46 of file NoSurfaceFilm.C.

◆ ~NoSurfaceFilm()

~NoSurfaceFilm ( )
virtual

Destructor.

Definition at line 57 of file NoSurfaceFilm.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ clone()

virtual autoPtr<SurfaceFilmModel<CloudType> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements SurfaceFilmModel< CloudType >.

Definition at line 81 of file NoSurfaceFilm.H.

◆ active()

bool active ( ) const
virtual

Flag to indicate whether model activates the surface film model.

Definition at line 64 of file NoSurfaceFilm.C.

◆ transferParcel()

bool transferParcel ( parcelType &  p,
const polyPatch &  pp,
bool &  keepParticle 
)
virtual

Transfer parcel from cloud to surface film.

Returns true if parcel is to be transferred

Implements SurfaceFilmModel< CloudType >.

Definition at line 72 of file NoSurfaceFilm.C.

◆ setParcelProperties()

void setParcelProperties ( parcelType &  p,
const label  filmCelli 
) const
virtual

Set parcel properties.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 84 of file NoSurfaceFilm.C.

◆ info()

void info ( Ostream &  os)
virtual

Write surface film info to stream.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 92 of file NoSurfaceFilm.C.

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