World Ocean Simulation System (WOSS) library
Public Member Functions | Protected Member Functions | List of all members
woss::SedimentGravel Class Reference

Gravel type implementation. More...

#include <sediment-definitions.h>

Inheritance diagram for woss::SedimentGravel:
Inheritance graph
Collaboration diagram for woss::SedimentGravel:
Collaboration graph

Public Member Functions

 SedimentGravel (double depth=1.0)
 
- Public Member Functions inherited from woss::Sediment
 Sediment ()
 
 Sediment (const std::string &name, double velc, double vels, double dens, double attc, double atts, double bottom_depth=1.0)
 
 Sediment (const Sediment &copy)=default
 
 Sediment (Sediment &&tmp)=default
 
virtual ~Sediment ()=default
 
virtual std::unique_ptr< Sediment > create () const
 
virtual std::unique_ptr< Sediment > create (const std::string &name, double velc, double vels, double dens, double attc, double atts, double bottom_depth=1.0) const
 
virtual std::unique_ptr< Sediment > clone () const
 
Sediment & setType (const std::string &name)
 
Sediment & setVelocityC (double vel)
 
Sediment & setVelocityS (double vel)
 
Sediment & setDensity (double dens)
 
Sediment & setAttenuationC (double att)
 
Sediment & setAttenuationS (double att)
 
Sediment & setDepth (double bottom_depth)
 
Sediment & set (const std::string &name, double velc, double vels, double dens, double attc, double atts, double bottom_depth)
 
double getVelocityC () const
 
double getVelocityS () const
 
double getDensity () const
 
double getAttenuationC () const
 
double getAttenuationS () const
 
double getDepth () const
 
std::string getType () const
 
virtual bool isValid () const
 
virtual const std::string getStringValues () const
 
Sediment & operator= (const Sediment &sed)=default
 
Sediment & operator= (Sediment &&tmp)=default
 

Protected Member Functions

double calculateVelocityS (double vels, double bottom_depth) const
 

Additional Inherited Members

- Static Public Member Functions inherited from woss::Sediment
static void setDebug (bool flag)
 
- Protected Attributes inherited from woss::Sediment
std::string type
 
double depth
 
double vel_c
 
double vel_s
 
double density
 
double att_c
 
double att_s
 
- Static Protected Attributes inherited from woss::Sediment
static bool debug = false
 

Detailed Description

Gravel type implementation.

Literature gravel implementation

Constructor & Destructor Documentation

◆ SedimentGravel()

SedimentGravel::SedimentGravel ( double  depth = 1.0)

References calculateVelocityS(), woss::Sediment::set(), and woss::Sediment::vel_s.

Here is the call graph for this function:

Member Function Documentation

◆ calculateVelocityS()

double SedimentGravel::calculateVelocityS ( double  vels,
double  bottom_depth 
) const
protected

Shear wave velocity formula taken from the literature

References woss::Sediment::set().

Referenced by SedimentGravel().

Here is the call graph for this function:
The documentation for this class was generated from the following files: