Surficial sediment geoacoustic parameters definitions. More...

#include <sediment-definitions.h>

Inheritance diagram for woss::Sediment:

Collaboration diagram for woss::Sediment:

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 &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

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)

std::ostream &	operator<< (std::ostream &os, const Sediment &instance)

Detailed Description

Surficial sediment geoacoustic parameters definitions.

The Sediment class provide an interface for creating and manipulating surficialg eoacoustic parameters.

Constructor & Destructor Documentation

◆ Sediment() [1/4]

Sediment::Sediment ( )

Sediment default constructor. The object created is not valid

◆ Sediment() [2/4]

Sediment::Sediment	(	const std::string &	name,
		double	velc,
		double	vels,
		double	dens,
		double	attc,
		double	atts,
		double	bottom_depth = `1.0`
	)

Sediment constructor

Parameters

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() [3/4]

woss::Sediment::Sediment ( const Sediment & copy )

default

◆ Sediment() [4/4]

woss::Sediment::Sediment ( Sediment && tmp )

default

◆ ~Sediment()

virtual woss::Sediment::~Sediment ( )

virtualdefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr< Sediment > woss::Sediment::clone ( ) const

inlinevirtual

Sediment virtual factory method

Returns: std::unique_ptr to a heap-created copy of this instance

Referenced by woss::WossDbManager::setCustomSediment().

◆ create() [1/2]

virtual std::unique_ptr< Sediment > woss::Sediment::create ( ) const

inlinevirtual

Sediment virtual factory method

Returns: a heap-created invalid Sediment object

◆ create() [2/2]

virtual std::unique_ptr< Sediment > woss::Sediment::create	(	const std::string &	name,
		double	velc,
		double	vels,
		double	dens,
		double	attc,
		double	atts,
		double	bottom_depth = `1.0`
	)		const

inlinevirtual

Sediment virtual factory method

Parameters

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]

Returns: std::unique_ptr to a heap-created Sediment object

References set().

Here is the call graph for this function:

◆ getAttenuationC()

double woss::Sediment::getAttenuationC ( ) const

inline

Gets compressional wave attenuation

Returns: attenuation [db/wavelength or user defined]

References att_c.

◆ getAttenuationS()

double woss::Sediment::getAttenuationS ( ) const

inline

Gets shear wave attenuation

Returns: attenuation [db/wavelength or user defined]

References att_s.

◆ getDensity()

double woss::Sediment::getDensity ( ) const

inline

Gets sediment density

Returns: density [g/cm^3 or user defined]

References density.

◆ getDepth()

double woss::Sediment::getDepth ( ) const

inline

Gets bottom depth

Returns: depth [m]

References depth.

◆ getStringValues()

const std::string Sediment::getStringValues ( ) const

virtual

Gets geoacoustic parameters in a formatted fashion

Returns: formatted string

References att_c, att_s, density, set(), vel_c, and vel_s.

Here is the call graph for this function:

◆ getType()

std::string woss::Sediment::getType ( ) const

inline

Gets sediment type name

Returns: type

References type.

◆ getVelocityC()

double woss::Sediment::getVelocityC ( ) const

inline

Gets compressional wave velocity

Returns: velocity [m/s]

References vel_c.

◆ getVelocityS()

double woss::Sediment::getVelocityS ( ) const

inline

Gets shear wave velocity

Returns: velocity [m/s]

References vel_s.

◆ isValid()

virtual bool woss::Sediment::isValid ( ) const

inlinevirtual

Checks the validity of geoacoustic parameters provided

Returns: true if Sediment is valid, false otherwise

References att_c, att_s, density, vel_c, and vel_s.

◆ operator=() [1/2]

Sediment & woss::Sediment::operator= ( const Sediment & sed )

default

◆ operator=() [2/2]

Sediment & woss::Sediment::operator= ( Sediment && tmp )

default

◆ set()

Sediment & woss::Sediment::set	(	const std::string &	name,
		double	velc,
		double	vels,
		double	dens,
		double	attc,
		double	atts,
		double	bottom_depth
	)

inline

Sets all parameters at one.

Parameters

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]

Returns: reference to *this

References att_c, att_s, density, depth, set(), type, vel_c, and vel_s.

Referenced by woss::SedimentGravel::calculateVelocityS(), woss::SedimentSilt::calculateVelocityS(), woss::SedimentMud::calculateVelocityS(), create(), getStringValues(), woss::SedimentGravel::SedimentGravel(), woss::SedimentMud::SedimentMud(), woss::SedimentSilt::SedimentSilt(), set(), setAttenuationC(), setAttenuationS(), setDebug(), setDensity(), setDepth(), setType(), setVelocityC(), and setVelocityS().

Here is the call graph for this function:

◆ setAttenuationC()

Sediment & woss::Sediment::setAttenuationC ( double att )

inline

Sets compressional wave attenuation

Parameters

att	attenuation [db/wavelength or user defined]

Returns: reference to *this

References att_c, and set().

Here is the call graph for this function:

◆ setAttenuationS()

Sediment & woss::Sediment::setAttenuationS ( double att )

inline

Sets shear wave attenuation

Parameters

att	attenuation [db/wavelength or user defined]

Returns: reference to *this

References att_s, and set().

Here is the call graph for this function:

◆ setDebug()

static void woss::Sediment::setDebug ( bool flag )

inlinestatic

Sets debug for the whole class

Parameters

flag	debug value

References debug, and set().

Here is the call graph for this function:

◆ setDensity()

Sediment & woss::Sediment::setDensity ( double dens )

inline

Sets sediment density

Parameters

dens	density [g/cm^3 or user defined]

Returns: reference to *this

References density, and set().

Here is the call graph for this function:

◆ setDepth()

Sediment & woss::Sediment::setDepth ( double bottom_depth )

inline

Sets bottom depth

Parameters

bottom_depth positive depth [m/s]

Returns: reference to *this

References depth, and set().

Here is the call graph for this function:

◆ setType()

Sediment & woss::Sediment::setType ( const std::string & name )

inline

Sets textual type name

Parameters

name	string name

Returns: reference to *this

References set(), and type.

Here is the call graph for this function:

◆ setVelocityC()

Sediment & woss::Sediment::setVelocityC ( double vel )

inline

Sets compressional wave velocity

Parameters

vel	velocity [m/s]

Returns: reference to *this

References set(), and vel_c.

Here is the call graph for this function:

◆ setVelocityS()

Sediment & woss::Sediment::setVelocityS ( double vel )

inline

Sets shear wave velocity

Parameters

vel	velocity [m/s]

Returns: reference to *this

References set(), and vel_s.

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const Sediment &	left,
		const Sediment &	right
	)

friend

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left != right, false otherwise

◆ operator* [1/3]

const Sediment operator*	(	const double	left,
		const Sediment &	right
	)

friend

Scalar multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator* [2/3]

const Sediment operator*	(	const Sediment &	left,
		const Sediment &	right
	)

friend

Multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator* [3/3]

const Sediment operator*	(	const Sediment &	left,
		double	right
	)

friend

Scalar multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator*= [1/2]

Sediment & operator*=	(	Sediment &	left,
		const Sediment &	right
	)

friend

Compound assignment multiplication operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator*= [2/2]

Sediment & operator*=	(	Sediment &	left,
		double	right
	)

friend

Compound assignment multiplication operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator+ [1/3]

const Sediment operator+	(	const double	left,
		const Sediment &	right
	)

friend

Scalar sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+ [2/3]

const Sediment operator+	(	const Sediment &	left,
		const Sediment &	right
	)

friend

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+ [3/3]

const Sediment operator+	(	const Sediment &	left,
		double	right
	)

friend

Scalar sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+= [1/2]

Sediment & operator+=	(	Sediment &	left,
		const Sediment &	right
	)

friend

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator+= [2/2]

Sediment & operator+=	(	Sediment &	left,
		double	right
	)

friend

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator- [1/3]

const Sediment operator-	(	const double	left,
		const Sediment &	right
	)

friend

Scalar subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator- [2/3]

const Sediment operator-	(	const Sediment &	left,
		const Sediment &	right
	)

friend

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator- [3/3]

const Sediment operator-	(	const Sediment &	left,
		double	right
	)

friend

Scalar subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-= [1/2]

Sediment & operator-=	(	Sediment &	left,
		const Sediment &	right
	)

friend

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator-= [2/2]

Sediment & operator-=	(	Sediment &	left,
		double	right
	)

friend

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator/ [1/3]

const Sediment operator/	(	const double	left,
		const Sediment &	right
	)

friend

Scalar division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator/ [2/3]

const Sediment operator/	(	const Sediment &	left,
		const Sediment &	right
	)

friend

Division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator/ [3/3]

const Sediment operator/	(	const Sediment &	left,
		double	right
	)

friend

Scalar division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator/= [1/2]

Sediment & operator/=	(	Sediment &	left,
		const Sediment &	right
	)

friend

Compound assignment division operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator/= [2/2]

Sediment & operator/=	(	Sediment &	left,
		double	right
	)

friend

Compound assignment division operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Sediment &	instance
	)

friend

<< operator

Parameters

os	left operand ostream reference
instance	right operand const Sediment reference

Returns: os reference after the operation

◆ operator==

bool operator==	(	const Sediment &	left,
		const Sediment &	right
	)

friend

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

Member Data Documentation

◆ att_c

double woss::Sediment::att_c

protected

Compressional wave attenuation [db/wavelength]

Referenced by getAttenuationC(), getStringValues(), isValid(), woss::operator*(), woss::operator*(), woss::operator*=(), woss::operator*=(), woss::operator+=(), woss::operator+=(), woss::operator-=(), woss::operator-=(), woss::operator/(), woss::operator/(), woss::operator/=(), woss::operator/=(), set(), and setAttenuationC().

◆ att_s

double woss::Sediment::att_s

protected

Shear wave attenuation [db/wavelength]

Referenced by getAttenuationS(), getStringValues(), isValid(), woss::operator*(), woss::operator*(), woss::operator*=(), woss::operator*=(), woss::operator+=(), woss::operator+=(), woss::operator-=(), woss::operator-=(), woss::operator/(), woss::operator/(), woss::operator/=(), woss::operator/=(), set(), and setAttenuationS().

◆ debug

bool Sediment::debug = false

staticprotected

Debug flag

Referenced by setDebug().

◆ density

double woss::Sediment::density

protected

Sediment density [g/cm^3]

Referenced by getDensity(), getStringValues(), isValid(), woss::operator*(), woss::operator*(), woss::operator*=(), woss::operator*=(), woss::operator+=(), woss::operator+=(), woss::operator-=(), woss::operator-=(), woss::operator/(), woss::operator/(), woss::operator/=(), woss::operator/=(), set(), and setDensity().

◆ depth

double woss::Sediment::depth

protected

Bottom depth. Used for shear wave velocity calculations [m]

Referenced by getDepth(), set(), and setDepth().

◆ type

std::string woss::Sediment::type

protected

Sediment type name

Referenced by getType(), woss::operator*(), woss::operator*(), woss::operator*=(), woss::operator*=(), woss::operator+=(), woss::operator+=(), woss::operator-=(), woss::operator-=(), woss::operator/(), woss::operator/(), woss::operator/=(), woss::operator/=(), set(), and setType().

◆ vel_c

double woss::Sediment::vel_c

protected

Compressional wave velocity [m/s]

Referenced by getStringValues(), getVelocityC(), isValid(), woss::operator*(), woss::operator*(), woss::operator*=(), woss::operator*=(), woss::operator+=(), woss::operator+=(), woss::operator-=(), woss::operator-=(), woss::operator/(), woss::operator/(), woss::operator/=(), woss::operator/=(), set(), and setVelocityC().

◆ vel_s

double woss::Sediment::vel_s

protected

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

woss/woss_def/sediment-definitions.h
woss/woss_def/sediment-definitions.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Sediment() [1/4]

◆ Sediment() [2/4]

◆ Sediment() [3/4]

◆ Sediment() [4/4]

◆ ~Sediment()

Member Function Documentation

◆ clone()

◆ create() [1/2]

◆ create() [2/2]

◆ getAttenuationC()

◆ getAttenuationS()

◆ getDensity()

◆ getDepth()

◆ getStringValues()

◆ getType()

◆ getVelocityC()

◆ getVelocityS()

◆ isValid()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set()

◆ setAttenuationC()

◆ setAttenuationS()

◆ setDebug()

◆ setDensity()

◆ setDepth()

◆ setType()

◆ setVelocityC()

◆ setVelocityS()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator*= [1/2]

◆ operator*= [2/2]

◆ operator+ [1/3]

◆ operator+ [2/3]

◆ operator+ [3/3]

◆ operator+= [1/2]

◆ operator+= [2/2]

◆ operator- [1/3]

◆ operator- [2/3]

◆ operator- [3/3]

◆ operator-= [1/2]

◆ operator-= [2/2]

◆ operator/ [1/3]

◆ operator/ [2/3]

◆ operator/ [3/3]

◆ operator/= [1/2]

◆ operator/= [2/2]

◆ operator<<

◆ operator==

Member Data Documentation

◆ att_c

◆ att_s

◆ debug

◆ density

◆ depth

◆ type

◆ vel_c

◆ vel_s