Public Member Functions | Protected Types | List of all members
NoSurfaceFilm< CloudType > Class Template Reference

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

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

Public Member Functions

 TypeName ("none")
 
 NoSurfaceFilm (const dictionary &, CloudType &)
 
 NoSurfaceFilm (const NoSurfaceFilm< CloudType > &dm)
 
virtual autoPtr< SurfaceFilmModel< CloudType > > clone () const
 
virtual ~NoSurfaceFilm ()
 
virtual bool active () const
 
virtual bool transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
 
virtual void setParcelProperties (parcelType &p, const label filmCelli) const
 
virtual void info (Ostream &os)
 
- Public Member Functions inherited from SurfaceFilmModel< CloudType >
void injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, CloudTrackType &cloud)
 
 TypeName ("surfaceFilmModel")
 
 declareRunTimeSelectionTable (autoPtr, SurfaceFilmModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 
 SurfaceFilmModel (CloudType &owner)
 
 SurfaceFilmModel (const dictionary &dict, CloudType &owner, const word &type)
 
 SurfaceFilmModel (const SurfaceFilmModel< CloudType > &sfm)
 
virtual autoPtr< SurfaceFilmModel< CloudType > > clone () const=0
 
virtual ~SurfaceFilmModel ()
 
const dimensionedVectorg () const
 
label nParcelsTransferred () const
 
label & nParcelsTransferred ()
 
label nParcelsInjected () const
 
label & nParcelsInjected ()
 
scalar & totalMassTransferred ()
 
scalar totalMassTransferred () const
 
void inject (TrackCloudType &cloud)
 

Protected Types

typedef CloudType::parcelType parcelType
 
- Protected Types inherited from SurfaceFilmModel< CloudType >
typedef CloudType::parcelType parcelType
 
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm
 

Additional Inherited Members

- Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 
- Protected Member Functions inherited from SurfaceFilmModel< CloudType >
virtual void cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)
 
virtual void cacheFilmFields (const label primaryPatchi, const areaFilm &)
 
void injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, TrackCloudType &cloud)
 
- Protected Attributes inherited from SurfaceFilmModel< CloudType >
const dimensionedVectorg_
 
label ejectedParcelType_
 
scalar injectionOffset_
 
scalar minDiameter_
 
scalarField massParcelPatch_
 
scalarField diameterParcelPatch_
 
Field< vectorUFilmPatch_
 
scalarField rhoFilmPatch_
 
Field< scalarFielddeltaFilmPatch_
 
label nParcelsTransferred_
 
label nParcelsInjected_
 
scalar totalMassTransferred_
 

Detailed Description

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

Place holder for 'none' option.

Source files

Definition at line 50 of file NoSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType
protected

Definition at line 59 of file NoSurfaceFilm.H.

Constructor & Destructor Documentation

◆ NoSurfaceFilm() [1/2]

NoSurfaceFilm ( const dictionary ,
CloudType owner 
)

Definition at line 28 of file NoSurfaceFilm.C.

◆ NoSurfaceFilm() [2/2]

Definition at line 39 of file NoSurfaceFilm.C.

◆ ~NoSurfaceFilm()

~NoSurfaceFilm
virtual

Definition at line 50 of file NoSurfaceFilm.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

◆ clone()

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

Definition at line 77 of file NoSurfaceFilm.H.

◆ active()

bool active
virtual

Definition at line 57 of file NoSurfaceFilm.C.

◆ transferParcel()

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

Implements SurfaceFilmModel< CloudType >.

Definition at line 65 of file NoSurfaceFilm.C.

◆ setParcelProperties()

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

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 77 of file NoSurfaceFilm.C.

◆ info()

void info ( Ostream os)
virtual

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 85 of file NoSurfaceFilm.C.


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