Public Member Functions | List of all members
waveSuperposition Class Reference

A wrapper around a list of wave models. Superimposes the modelled values of elevation and velocity. More...

Public Member Functions

 waveSuperposition (const objectRegistry &db)
 Construct from a database. More...
 
 waveSuperposition (const waveSuperposition &waves)
 Construct a copy. More...
 
 waveSuperposition (const objectRegistry &db, const dictionary &dict)
 Construct from a database and gravity. More...
 
 ~waveSuperposition ()
 Destructor. More...
 
tmp< scalarField > height (const scalar t, const vectorField &p) const
 Get the height above the waves at a given time and global positions. More...
 
tmp< vectorField > ULiquid (const scalar t, const vectorField &p) const
 Get the liquid velocity at a given time and global positions. More...
 
tmp< vectorField > UGas (const scalar t, const vectorField &p) const
 Get the gas velocity at a given time and global positions. More...
 
vector UMean () const
 Get the mean flow velocity. More...
 
void write (Ostream &) const
 Write. More...
 

Detailed Description

A wrapper around a list of wave models. Superimposes the modelled values of elevation and velocity.

Source files

Definition at line 49 of file waveSuperposition.H.

Constructor & Destructor Documentation

◆ waveSuperposition() [1/3]

waveSuperposition ( const objectRegistry &  db)

Construct from a database.

Definition at line 143 of file waveSuperposition.C.

Referenced by waveSuperposition::waveSuperposition().

Here is the caller graph for this function:

◆ waveSuperposition() [2/3]

waveSuperposition ( const waveSuperposition &  waves)

Construct a copy.

Definition at line 156 of file waveSuperposition.C.

References waveSuperposition::waveSuperposition().

Here is the call graph for this function:

◆ waveSuperposition() [3/3]

waveSuperposition ( const objectRegistry &  db,
const dictionary &  dict 
)

Construct from a database and gravity.

Definition at line 170 of file waveSuperposition.C.

References dictionaryName::dictName(), forAll, dictionary::lookup(), waveModel::New(), Foam::readScalar(), and List< T >::setSize().

Here is the call graph for this function:

◆ ~waveSuperposition()

~waveSuperposition ( )

Destructor.

Definition at line 214 of file waveSuperposition.C.

References waveSuperposition::height().

Here is the call graph for this function:

Member Function Documentation

◆ height()

Foam::tmp< Foam::scalarField > height ( const scalar  t,
const vectorField &  p 
) const

Get the height above the waves at a given time and global positions.

Definition at line 221 of file waveSuperposition.C.

References List< T >::size(), waveSuperposition::ULiquid(), and Foam::zip().

Referenced by waveAlphaFvPatchScalarField::alpha(), waveVelocityFvPatchVectorField::U(), and waveSuperposition::~waveSuperposition().

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

◆ ULiquid()

Foam::tmp< Foam::vectorField > ULiquid ( const scalar  t,
const vectorField &  p 
) const

Get the liquid velocity at a given time and global positions.

Definition at line 238 of file waveSuperposition.C.

References List< T >::size(), waveSuperposition::UGas(), and waveSuperposition::UMean().

Referenced by waveSuperposition::height(), and waveVelocityFvPatchVectorField::U().

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

◆ UGas()

Foam::tmp< Foam::vectorField > UGas ( const scalar  t,
const vectorField &  p 
) const

Get the gas velocity at a given time and global positions.

Definition at line 253 of file waveSuperposition.C.

References List< T >::size(), waveSuperposition::UMean(), Tensor< Cmpt >::x(), Tensor< Cmpt >::y(), and Tensor< Cmpt >::z().

Referenced by waveVelocityFvPatchVectorField::U(), and waveSuperposition::ULiquid().

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

◆ UMean()

vector UMean ( ) const
inline

Get the mean flow velocity.

Definition at line 142 of file waveSuperposition.H.

References waveSuperposition::write().

Referenced by waveSuperposition::UGas(), and waveSuperposition::ULiquid().

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

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 269 of file waveSuperposition.C.

References token::BEGIN_BLOCK, token::BEGIN_LIST, Foam::decrIndent(), token::END_BLOCK, token::END_LIST, token::END_STATEMENT, forAll, Foam::incrIndent(), Foam::indent(), Foam::nl, Foam::type(), and Ostream::writeKeyword().

Referenced by waveSuperposition::UMean(), and waveVelocityFvPatchVectorField::write().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13