World Ocean Simulation System (WOSS) library
|
Surficial sediment geoacoustic parameters definitions. More...
#include <sediment-definitions.h>
Public Member Functions | |
Sediment () | |
Sediment (const ::std::string &name, double velc, double vels, double dens, double attc, double atts, double bottom_depth=1.0) | |
Sediment (const Sediment ©) | |
virtual Sediment * | create () const |
virtual Sediment * | create (const ::std::string &name, double velc, double vels, double dens, double attc, double atts, double bottom_depth=1.0) const |
virtual Sediment * | create (const Sediment ©) const |
virtual 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 &time) |
friend::std::ostream & | operator<< (::std::ostream &os, const Sediment &instance) |
Static Public Member Functions | |
static void | setDebug (bool flag) |
Protected Attributes | |
::std::string | type |
double | depth |
double | vel_c |
double | vel_s |
double | density |
double | att_c |
double | att_s |
Static Protected Attributes | |
static bool | debug = false |
Friends | |
const Sediment | operator+ (const Sediment &left, const Sediment &right) |
const Sediment | operator- (const Sediment &left, const Sediment &right) |
const Sediment | operator/ (const Sediment &left, const Sediment &right) |
const Sediment | operator* (const Sediment &left, const Sediment &right) |
Sediment & | operator+= (Sediment &left, const Sediment &right) |
Sediment & | operator-= (Sediment &left, const Sediment &right) |
Sediment & | operator/= (Sediment &left, const Sediment &right) |
Sediment & | operator*= (Sediment &left, const Sediment &right) |
Sediment & | operator+= (Sediment &left, double right) |
Sediment & | operator-= (Sediment &left, double right) |
Sediment & | operator/= (Sediment &left, double right) |
Sediment & | operator*= (Sediment &left, double right) |
bool | operator== (const Sediment &left, const Sediment &right) |
bool | operator!= (const Sediment &left, const Sediment &right) |
const Sediment | operator+ (const double left, const Sediment &right) |
const Sediment | operator- (const double left, const Sediment &right) |
const Sediment | operator/ (const double left, const Sediment &right) |
const Sediment | operator* (const double left, const Sediment &right) |
const Sediment | operator+ (const Sediment &left, double right) |
const Sediment | operator- (const Sediment &left, double right) |
const Sediment | operator/ (const Sediment &left, double right) |
const Sediment | operator* (const Sediment &left, double right) |
Surficial sediment geoacoustic parameters definitions.
The Sediment class provide an interface for creating and manipulating surficialg eoacoustic parameters.
Sediment::Sediment | ( | ) |
Sediment::Sediment | ( | const ::std::string & | name, |
double | velc, | ||
double | vels, | ||
double | dens, | ||
double | attc, | ||
double | atts, | ||
double | bottom_depth = 1.0 |
||
) |
Sediment constructor
name | textual name |
velc | compressional wave velocity [m/s] |
vels | shear wave velocity [m/s] |
dens | sediment density [g/cm^3 or user defined] |
attc | compressional wave attenuation [db/wavelength or user defined] |
atts | shear wave attenuation [db/wavelength or user defined] |
bottom_depth | bottom depth [m] |
Sediment::Sediment | ( | const Sediment & | copy | ) |
|
inlinevirtual |
Sediment virtual factory method
References Sediment().
Referenced by woss::DefHandler::operator=().
|
inlinevirtual |
Sediment virtual factory method
References Sediment().
|
inlinevirtual |
Sediment virtual factory method
name | textual name |
velc | compressional wave velocity [m/s] |
vels | shear wave velocity [m/s] |
dens | sediment density [g/cm^3 or user defined] |
attc | compressional wave attenuation [db/wavelength or user defined] |
atts | shear wave attenuation [db/wavelength or user defined] |
bottom_depth | bottom depth [m] |
References Sediment().
Sediment virtual factory method
copy | Sediment to be copied |
References Sediment().
|
inline |
Gets compressional wave attenuation
References att_c.
|
inline |
|
inline |
|
inline |
|
virtual |
|
inline |
Gets sediment type name
References type.
Referenced by woss::WossDbManager::getSediment(), and woss::BellhopWoss::writeSediment().
|
inline |
|
inline |
|
inlinevirtual |
friend::std::ostream & woss::Sediment::operator<< | ( | ::std::ostream & | os, |
const Sediment & | instance | ||
) |
<< operator
os | left operand ostream reference |
instance | right operand const Sediment reference |
|
inline |
Sets all parameters at one.
name | textual name |
velc | compressional wave velocity [m/s] |
vels | shear wave velocity [m/s] |
dens | sediment density [g/cm^3 or user defined] |
attc | compressional wave attenuation [db/wavelength or user defined] |
atts | shear wave attenuation [db/wavelength or user defined] |
bottom_depth | bottom depth ( > 0 ) [m] |
References att_c, att_s, density, depth, type, vel_c, and vel_s.
|
inline |
Sets compressional wave attenuation
att | attenuation [db/wavelength or user defined] |
References att_c.
|
inline |
Sets shear wave attenuation
att | attenuation [db/wavelength or user defined] |
References att_s.
|
inlinestatic |
|
inline |
Sets sediment density
dens | density [g/cm^3 or user defined] |
References density.
|
inline |
Sets bottom depth
bottom_depth | positive depth [m/s] |
References depth.
|
inline |
|
inline |
Sets compressional wave velocity
vel | velocity [m/s] |
References vel_c.
|
inline |
Inequality operator
left | left operand const reference |
right | right operand const reference |
Scalar multiplication operator
left | left operand const reference |
right | right operand const reference |
Multiplication operator
left | left operand const reference |
right | right operand const reference |
Scalar multiplication operator
left | left operand const reference |
right | right operand const reference |
Compound assignment multiplication operator
left | left operand reference |
right | right operand const reference |
Compound assignment multiplication operator
left | left operand reference |
right | right operand const reference |
Scalar sum operator
left | left operand const reference |
right | right operand const reference |
Sum operator
left | left operand const reference |
right | right operand const reference |
Scalar sum operator
left | left operand const reference |
right | right operand const reference |
Compound assignment sum operator
left | left operand reference |
right | right operand const reference |
Compound assignment sum operator
left | left operand reference |
right | right operand const reference |
Scalar subtraction operator
left | left operand const reference |
right | right operand const reference |
Subtraction operator
left | left operand const reference |
right | right operand const reference |
Scalar subtraction operator
left | left operand const reference |
right | right operand const reference |
Compound assignment subtraction operator
left | left operand reference |
right | right operand const reference |
Compound assignment subtraction operator
left | left operand reference |
right | right operand const reference |
Scalar division operator
left | left operand const reference |
right | right operand const reference |
Division operator
left | left operand const reference |
right | right operand const reference |
Scalar division operator
left | left operand const reference |
right | right operand const reference |
Compound assignment division operator
left | left operand reference |
right | right operand const reference |
Compound assignment division operator
left | left operand reference |
right | right operand const reference |
Equality operator
left | left operand const reference |
right | right operand const reference |
|
protected |
Compressional wave attenuation [db/wavelength]
Referenced by getAttenuationC(), getStringValues(), isValid(), woss::operator*(), woss::operator*=(), woss::operator+=(), woss::operator-=(), woss::operator/(), woss::operator/=(), operator=(), Sediment(), set(), and setAttenuationC().
|
protected |
Shear wave attenuation [db/wavelength]
Referenced by getAttenuationS(), getStringValues(), isValid(), woss::operator*(), woss::operator*=(), woss::operator+=(), woss::operator-=(), woss::operator/(), woss::operator/=(), operator=(), Sediment(), set(), and setAttenuationS().
|
staticprotected |
Debug flag
Referenced by setDebug().
|
protected |
Sediment density [g/cm^3]
Referenced by getDensity(), getStringValues(), isValid(), woss::operator*(), woss::operator*=(), woss::operator+=(), woss::operator-=(), woss::operator/(), woss::operator/=(), operator=(), Sediment(), set(), and setDensity().
|
protected |
Bottom depth. Used for shear wave velocity calculations [m]
Referenced by getDepth(), operator=(), Sediment(), set(), and setDepth().
|
protected |
Sediment type name
Referenced by getType(), woss::operator*(), woss::operator*=(), woss::operator+=(), woss::operator-=(), woss::operator/(), woss::operator/=(), operator=(), Sediment(), set(), and setType().
|
protected |
Compressional wave velocity [m/s]
Referenced by getStringValues(), getVelocityC(), isValid(), woss::operator*(), woss::operator*=(), woss::operator+=(), woss::operator-=(), woss::operator/(), woss::operator/=(), operator=(), Sediment(), set(), and setVelocityC().
|
protected |
Shear wave velocity [m/s]
Referenced by getStringValues(), getVelocityS(), isValid(), woss::operator*(), woss::operator*=(), woss::operator+=(), woss::operator-=(), woss::operator/(), woss::operator/=(), operator=(), Sediment(), set(), and setVelocityS().