Public Member Functions | List of all members
waveAlpha Class Reference

Initialises the phase fraction to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class. More...

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

Public Member Functions

 TypeName ("waveAlpha")
 Runtime type information. More...
 
 waveAlpha (const dictionary &dict, DimensionedField< scalar, fvMesh > &field)
 Construct with dictionary to initialise given field. More...
 
 waveAlpha (const waveAlpha &dff, DimensionedField< scalar, fvMesh > &field)
 Construct a copy for the given field. More...
 
virtual autoPtr< DimensionedFieldFunction< DimensionedField< scalar, fvMesh > > > clone (DimensionedField< scalar, fvMesh > &field) const
 Construct and return a clone for the specified field. More...
 
virtual ~waveAlpha ()
 Destructor. More...
 
virtual void evaluate ()
 Evaluate the function and set the field. More...
 
virtual void write (Ostream &os) const
 Write data to dictionary stream. More...
 
- Public Member Functions inherited from DimensionedFieldFunction< DimensionedField< scalar, fvMesh > >
 TypeName ("DimensionedFieldFunction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, DimensionedFieldFunction, dictionary,(const dictionary &dict, DimensionedField< scalar, fvMesh > &field),(dict, field))
 
 DimensionedFieldFunction (const dictionary &dict, DimensionedField< scalar, fvMesh > &field)
 Construct with dictionary to initialise given field. More...
 
 DimensionedFieldFunction (const DimensionedFieldFunction &dff, DimensionedField< scalar, fvMesh > &field)
 Construct a copy for the given field. More...
 
 DimensionedFieldFunction (const DimensionedFieldFunction< DimensionedField< scalar, fvMesh > > &)=delete
 Disallow default bitwise copy construction. More...
 
virtual autoPtr< DimensionedFieldFunction< DimensionedField< scalar, fvMesh > > > clone () const
 Construct and return a clone for the specified field. More...
 
virtual ~DimensionedFieldFunction ()
 Destructor. More...
 
virtual bool update ()
 Update the field if the function has changed and return true. More...
 
virtual void reset ()
 Reset the field size. More...
 
void operator= (const DimensionedFieldFunction< DimensionedField< scalar, fvMesh > > &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DimensionedFieldFunction< DimensionedField< scalar, fvMesh > >
static autoPtr< DimensionedFieldFunction< DimensionedField< scalar, fvMesh > > > New (const dictionary &dict, DimensionedField< scalar, fvMesh > &field)
 Select null constructed. More...
 
- Protected Attributes inherited from DimensionedFieldFunction< DimensionedField< scalar, fvMesh > >
DimensionedField< scalar, fvMesh > & field_
 Reference to the field the function applies to. More...
 

Detailed Description

Initialises the phase fraction to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class.

Usage
Property Description Required? Default
liquid Is the alpha field that of the liquid? no true

Example of the boundary condition specification: 

    internalField
    {
        type        waveAlpha;
        libs        ("libwaves.so");
    }
See also
Foam::waveAlphaFvPatchScalarField Foam::waveSuperposition
Source files

Definition at line 84 of file waveAlpha_DimensionedFieldFunction.H.

Constructor & Destructor Documentation

◆ waveAlpha() [1/2]

waveAlpha ( const dictionary &  dict,
DimensionedField< scalar, fvMesh > &  field 
)

Construct with dictionary to initialise given field.

Definition at line 57 of file waveAlpha_DimensionedFieldFunction.C.

◆ waveAlpha() [2/2]

waveAlpha ( const waveAlpha &  dff,
DimensionedField< scalar, fvMesh > &  field 
)

Construct a copy for the given field.

Definition at line 68 of file waveAlpha_DimensionedFieldFunction.C.

◆ ~waveAlpha()

virtual ~waveAlpha ( )
inlinevirtual

Destructor.

Definition at line 124 of file waveAlpha_DimensionedFieldFunction.H.

Member Function Documentation

◆ TypeName()

TypeName ( "waveAlpha"  )

Runtime type information.

◆ clone()

virtual autoPtr< DimensionedFieldFunction<DimensionedField<scalar, fvMesh> > > clone ( DimensionedField< scalar, fvMesh > &  field) const
virtual

Construct and return a clone for the specified field.

Implements DimensionedFieldFunction< DimensionedField< scalar, fvMesh > >.

◆ evaluate()

void evaluate ( )
virtual

Evaluate the function and set the field.

Implements DimensionedFieldFunction< DimensionedField< scalar, fvMesh > >.

Definition at line 100 of file waveAlpha_DimensionedFieldFunction.C.

References primitiveMesh::cellCentres(), waveSuperposition::height(), Foam::levelSetFraction(), mesh, waveSuperposition::New(), polyMesh::points(), fvMesh::time(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write data to dictionary stream.

Implements DimensionedFieldFunction< DimensionedField< scalar, fvMesh > >.

Definition at line 117 of file waveAlpha_DimensionedFieldFunction.C.

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