JACOUSTICS::JGEOMETRY::JString Struct Reference

String geometry. More...

#include <JGeometry.hh>

Inheritance diagram for JACOUSTICS::JGEOMETRY::JString:

Public Member Functions
	JString ()
	Default constructor.
	JString (const JVector3D &position, const JMechanics &mechanics)
	Constructor.
template<class T >
	JString (const JVector3D &position, const JMechanics &mechanics, T __begin, T __end)
	Constructor.
const JMechanics &	getMechanics () const
	Get mechanical model parameters.
JFloor &	operator[] (size_t floor)
	Get floor data.
bool	hasFloor (size_t floor) const
	Check if this string has receiver at given floor.
double	getHeight (const size_t floor) const
	Get height of receiver at given floor with respect to reference position.
JPosition3D	getPosition (const JMODEL::JString &parameters, const size_t floor) const
	Get position of receiver at given floor according to given string model parameters.
JPosition3D	getPosition (const size_t floor) const
	Get position of receiver at given floor.
double	getDistance (const JMODEL::JString &parameters, const JVector3D &position, const size_t floor) const
	Get distance between given position and floor according to given string model parameters.
JMODEL::JString	getGradient (const JMODEL::JString &parameters, const JVector3D &position, const size_t floor) const
	Get model gradient of distance between given position and floor according to given string model parameters.
const JPosition3D &	getPosition () const
	Get position.
JPosition3D &	getPosition ()
	Get position.
void	setPosition (const JVector3D &pos)
	Set position.
	operator JAngle3D () const
	Type conversion operator.
	operator JVersor3D () const
	Type conversion operator.
JPosition3D &	rotate (const JRotation3D &R)
	Rotate.
JPosition3D &	rotate (const JRotation3X &R)
	Rotate around X-axis.
JPosition3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis.
JPosition3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis.
JPosition3D &	rotate (const JQuaternion3D &Q)
	Rotate.
JPosition3D &	rotate_back (const JRotation3D &R)
	Rotate back.
JPosition3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis.
JPosition3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis.
JPosition3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis.
JPosition3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back.
void	transform (const JRotation3D &R, const JVector3D &pos)
	Transform position.
JVector3D &	transform (const JMatrix3D &T)
	Transform.
void	transform_back (const JRotation3D &R, const JVector3D &pos)
	Transform back position.
double	getDot (const JAngle3D &angle) const
	Get dot product.
double	getDot (const JVersor3D &dir) const
	Get dot product.
double	getDot (const JVersor3Z &dir) const
	Get dot product.
double	getDot (const JVector3D &vector) const
	Get dot product.
	operator JVector2D () const
	Type conversion operator.
double	getX () const
	Get x position.
double	getY () const
	Get y position.
double	getZ () const
	Get z position.
JVector3D &	negate ()
	Negate vector.
JVector3D &	add (const JVector3D &vector)
	Add vector.
JVector3D &	sub (const JVector3D &vector)
	Subtract vector.
JVector3D &	mul (const double factor)
	Scale vector.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.
JVector3D &	div (const double factor)
	Scale vector.
bool	equals (const JVector3D &vector, const double precision=std::numeric_limits< double >::min()) const
	Check equality.
double	getLengthSquared () const
	Get length squared.
double	getLength () const
	Get length.
double	getDistanceSquared (const JVector3D &pos) const
	Get squared of distance to point.
double	getDistance (const JVector3D &pos) const
	Get distance to point.
JVector3D &	getCross (const JVector3D &first, const JVector3D &second)
	Get cross product.

Static Public Member Functions
static double	getLength (const JMODEL::JString &parameters, const JMechanics &mechanics, const double height)
	Get approximate length of string.
static double	getHeight (const JMODEL::JString &parameters, const JMechanics &mechanics, const double length, const double precision=PRECISION_M)
	Get approximate height of string.
static JPosition3D	getPosition (const JMODEL::JString &parameters, const JMechanics &mechanics, const double height)
	Get position at given height according to given string model parameters and mechanics.

Public Attributes
JPosition3D	hydrophone
	Hydrophone.
bool	has_hydrophone

Static Public Attributes
static constexpr double	PRECISION_M = 1.0e-4
	precision of height evaluation [m]

Protected Attributes
double	__x
double	__y
double	__z

Private Attributes
JMechanics	mechanics
	Mechanical data.

Friends
std::ostream &	operator<< (std::ostream &out, const JString &string)
	Write string parameters to output stream.

Detailed Description

String geometry.

This data structure provides for the implementation of the dynamical geometry of a detector string.
In this, the position of floor > 0 corresponds to the piezo sensor which is located inside the optical module and
the position of floor = 0 to the hydrophone which is optionally mounted on the anchor.
The reference position of a string corresponds to the top of the T-bar located on the anchor.
The position of a piezo sensor depends on the tilt of the string and the mechanical model.
The position of the hydrophone is fixed. Its value is relative to the reference position of the string.

Definition at line 140 of file JGeometry.hh.

Constructor & Destructor Documentation

JString() [1/3]

JACOUSTICS::JGEOMETRY::JString::JString ( )

inline

Default constructor.

Definition at line 231 of file JGeometry.hh.

                :
        has_hydrophone(false)
      {}

JString() [2/3]

JACOUSTICS::JGEOMETRY::JString::JString ( const JVector3D & position, const JMechanics & mechanics )

inline

Constructor.

The given position corresponds to the reference position of the string from which the positions of the piezo sensors and hydrophone are determined.

Parameters

position	position
mechanics	mechanical model parameters

Definition at line 245 of file JGeometry.hh.

                                           :
        JPosition3D(position),
        has_hydrophone(false),
        mechanics(mechanics)
      {}

JString() [3/3]

template<class T >

JACOUSTICS::JGEOMETRY::JString::JString ( const JVector3D & position, const JMechanics & mechanics, T __begin, T __end )

inline

Constructor.

The given position corresponds to the reference position of the string from which the positions of the piezo sensors and hydrophone are determined.

The template parameter should correspond to a data type which implements the following policy methods.

    int                       getFloor();
    JGEOMETRY3d::JPosition3D  getPosition();

In this, the position should correspond to the center of the optical module.

Note that the position of the piezo is offset by JDETECTOR::getPiezoPosition with respect to the center of the optical module.
The position of the hydrophone should separately be set.

Parameters

position	position
mechanics	mechanical model parameters
__begin	begin of optical modules
__end	end of optical modules

Definition at line 275 of file JGeometry.hh.

                       :
        JPosition3D(position),
        has_hydrophone(false),
        mechanics(mechanics)
      {
        for (T i = __begin; i != __end; ++i) {
          (*this)[i->getFloor()] = JFloor(this->getDistance(i->getPosition() + JDETECTOR::getPiezoPosition()),
                                          JVector2D(i->getX() - this->getX(),
                                                    i->getY() - this->getY()));
        }
      }

Member Function Documentation

getLength() [1/2]

static double JACOUSTICS::JGEOMETRY::JString::getLength ( const JMODEL::JString & parameters, const JMechanics & mechanics, const double height )

inlinestatic

Get approximate length of string.

Parameters

parameters	parameters
mechanics	mechanics
height	height

Returns

length

Definition at line 158 of file JGeometry.hh.

      {
        const double T2 = parameters.getLengthSquared();
        
        const double x  = 1.0 - mechanics.a*height;
 
        return sqrt(1.0 + T2) * height  +  T2*mechanics.b * log(x)  +  0.5*T2*mechanics.a*mechanics.b*mechanics.b * (1.0/x - 1.0);
      }

getHeight() [1/2]

static double JACOUSTICS::JGEOMETRY::JString::getHeight ( const JMODEL::JString & parameters, const JMechanics & mechanics, const double length, const double precision = PRECISION_M )

inlinestatic

Get approximate height of string.

Parameters

parameters	parameters
mechanics	mechanics
length	length
precision	precision

Returns

height

Definition at line 179 of file JGeometry.hh.

      {
        const size_t MAXIMUM_NUMBER_OF_ITERATIONS = 10;
        
        const double T2 = parameters.getLengthSquared();
 
        double z = length;    // start value
 
        for (size_t i = 0; i != MAXIMUM_NUMBER_OF_ITERATIONS; ++i) {
 
          const double ls = getLength(parameters, mechanics, z)  -  length;
 
          if (fabs(ls) <= precision) {
            break;
          }
 
          const double vs = 1.0 - mechanics.a*mechanics.b / (1.0 - mechanics.a*z);
 
          z -= ls / (1.0 + 0.5*T2 * vs*vs);
        }
 
        return z;
      }

getPosition() [1/5]

static JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const JMODEL::JString & parameters, const JMechanics & mechanics, const double height )

inlinestatic

Get position at given height according to given string model parameters and mechanics.

Parameters

parameters	parameters
mechanics	mechanics
height	height

Returns

position

Definition at line 215 of file JGeometry.hh.

      {
        const double h1 = height * (1.0 + parameters.vs);
        const double z1 = mechanics.getHeight(h1);
 
        return JPosition3D(parameters.tx * z1  +  parameters.tx2 * h1*h1,
                           parameters.ty * z1  +  parameters.ty2 * h1*h1,
                           getHeight(parameters, mechanics, h1));
      }

getMechanics()

const JMechanics & JACOUSTICS::JGEOMETRY::JString::getMechanics ( ) const

inline

Get mechanical model parameters.

Returns

mechanical model parameters

Definition at line 296 of file JGeometry.hh.

      {
        return mechanics;
      }

operator[]()

JFloor & JACOUSTICS::JGEOMETRY::JString::operator[] ( size_t floor )

inline

Get floor data.

Parameters

floor

floor number

Returns

floor data

Definition at line 308 of file JGeometry.hh.

      {
        if (floor >= this->size()) {
          this->resize(floor + 1);
        }
 
        return static_cast<std::vector<JFloor>&>(*this)[floor];
      }

hasFloor()

bool JACOUSTICS::JGEOMETRY::JString::hasFloor ( size_t floor ) const

inline

Check if this string has receiver at given floor.

Parameters

floor

floor

Returns

true if receiver present; else false

Definition at line 324 of file JGeometry.hh.

      {
        if (floor == 0)
          return has_hydrophone;
        else
          return (floor < this->size());
      }

getHeight() [2/2]

double JACOUSTICS::JGEOMETRY::JString::getHeight ( const size_t floor ) const

inline

Get height of receiver at given floor with respect to reference position.

Parameters

floor

floor

Returns

height

Definition at line 339 of file JGeometry.hh.

      {
        if (!hasFloor(floor)) {
          THROW(JValueOutOfRange, "Invalid floor " << floor);
        }
 
        if (floor == 0)
          return hydrophone.getZ();
        else
          return (*this)[floor].getHeight();
      }

getPosition() [2/5]

JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const JMODEL::JString & parameters, const size_t floor ) const

inline

Get position of receiver at given floor according to given string model parameters.

Parameters

parameters	parameters
floor	floor

Returns

position

Definition at line 359 of file JGeometry.hh.

      {
        if (!hasFloor(floor)) {
          THROW(JValueOutOfRange, "Invalid floor " << floor);
        }
 
        if (floor == 0)
          return this->getPosition() + hydrophone.getPosition();
        else
          return this->getPosition() + getPosition(parameters, this->mechanics, (*this)[floor].getHeight()) + (*this)[floor].getPosition();
      }

getPosition() [3/5]

JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const size_t floor ) const

inline

Get position of receiver at given floor.

Parameters

floor

floor

Returns

position

Definition at line 379 of file JGeometry.hh.

      {
        if (!hasFloor(floor)) {
          THROW(JValueOutOfRange, "Invalid floor " << floor);
        }
 
        if (floor == 0)
          return this->getPosition() + hydrophone.getPosition();
        else
          return this->getPosition() + JPosition3D(0.0, 0.0, (*this)[floor].getHeight()) + (*this)[floor].getPosition();
      }

getDistance() [1/2]

double JACOUSTICS::JGEOMETRY::JString::getDistance ( const JMODEL::JString & parameters, const JVector3D & position, const size_t floor ) const

inline

Get distance between given position and floor according to given string model parameters.

Parameters

parameters	parameters
position	position
floor	floor

Returns

distance

Definition at line 400 of file JGeometry.hh.

      {
        return this->getPosition(parameters, floor).getDistance(position);
      }

getGradient()

JMODEL::JString JACOUSTICS::JGEOMETRY::JString::getGradient ( const JMODEL::JString & parameters, const JVector3D & position, const size_t floor ) const

inline

Get model gradient of distance between given position and floor according to given string model parameters.

Parameters

parameters	parameters
position	position
floor	floor

Returns

gradient

Definition at line 416 of file JGeometry.hh.

      {
        if (floor == 0) {
 
          return JMODEL::JString();
 
        } else if (floor < this->size()) {
 
          const JPosition3D pos    = this->getPosition(parameters, floor);
          const double      height = (*this)[floor].getHeight();
          const double      h1     = height * (1.0 + parameters.vs);
          const double      z1     = mechanics.getHeight(h1);
 
          const double tx = parameters.tx;
          const double ty = parameters.ty;
          const double tz = sqrt(1.0 - tx*tx - ty*ty);
 
          const double dx = pos.getX() - position.getX();
          const double dy = pos.getY() - position.getY();
          const double dz = pos.getZ() - position.getZ();
 
          const double D  = sqrt(dx*dx + dy*dy + dz*dz);
          const double vw = 1.0  -  mechanics.a * mechanics.b / (1.0 - mechanics.a*h1);
          const double vs = 1.0  +  0.5 * parameters.getLengthSquared() * vw;
          
          return JMODEL::JString(z1 * dx / D  -  height * (tx / tz) * dz / D,
                                 z1 * dy / D  -  height * (ty / tz) * dz / D,
                                 h1*h1 * dx / D,
                                 h1*h1 * dy / D,
                                 height * vw * (tx * dx  +  ty * dy) / D  +  h1 * (dz / vs) / D);
 
        } else {
 
          THROW(JValueOutOfRange, "Invalid floor " << floor);
        }       
      }

getPosition() [4/5]

const JPosition3D & JGEOMETRY3D::JPosition3D::getPosition ( ) const

inline

Get position.

Returns

position

Definition at line 130 of file JPosition3D.hh.

    {
      return static_cast<const JPosition3D&>(*this);
    }

getPosition() [5/5]

JPosition3D & JGEOMETRY3D::JPosition3D::getPosition ( )

inline

Get position.

Returns

position

Definition at line 141 of file JPosition3D.hh.

    {
      return static_cast<JPosition3D&>(*this);
    }

setPosition()

void JGEOMETRY3D::JPosition3D::setPosition ( const JVector3D & pos )

inlineinherited

Set position.

Parameters

pos

position

Definition at line 152 of file JPosition3D.hh.

    {
      static_cast<JVector3D&>(*this) = pos;
    }

operator JAngle3D()

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 163 of file JPosition3D.hh.

    {
      return JAngle3D(getX(), getY(), getZ());
    }

operator JVersor3D()

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns

direction

Definition at line 174 of file JPosition3D.hh.

    {
      return JVersor3D(getX(), getY(), getZ());
    }

rotate() [1/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3D & R )

inlineinherited

Rotate.

Parameters

R	rotation matrix

Returns

this position

Definition at line 186 of file JPosition3D.hh.

    {
      R.rotate(__x, __y, __z);
 
      return *this;
    }

rotate() [2/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3X & R )

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 214 of file JPosition3D.hh.

    {
      R.rotate(__y, __z);
 
      return *this;
    }

rotate() [3/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Y & R )

inlineinherited

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 242 of file JPosition3D.hh.

    {
      R.rotate(__x, __z);
 
      return *this;
    }

rotate() [4/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Z & R )

inlineinherited

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 270 of file JPosition3D.hh.

    {
      R.rotate(__x, __y);
 
      return *this;
    }

rotate() [5/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JQuaternion3D & Q )

inlineinherited

Rotate.

Parameters

Q	quaternion

Returns

this position

Definition at line 298 of file JPosition3D.hh.

    {
      Q.rotate(__x, __y, __z);
      
      return *this;
    }

rotate_back() [1/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3D & R )

inlineinherited

Rotate back.

Parameters

R	rotation matrix

Returns

this position

Definition at line 200 of file JPosition3D.hh.

    {
      R.rotate_back(__x, __y, __z);
 
      return *this;
    }

rotate_back() [2/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3X & R )

inlineinherited

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 228 of file JPosition3D.hh.

    {
      R.rotate_back(__y, __z);
 
      return *this;
    }

rotate_back() [3/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Y & R )

inlineinherited

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 256 of file JPosition3D.hh.

    {
      R.rotate_back(__x, __z);
 
      return *this;
    }

rotate_back() [4/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Z & R )

inlineinherited

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 284 of file JPosition3D.hh.

    {
      R.rotate_back(__x, __y);
 
      return *this;
    }

rotate_back() [5/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JQuaternion3D & Q )

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns

this position

Definition at line 312 of file JPosition3D.hh.

    {
      Q.rotate_back(__x, __y, __z);
 
      return *this;
    }

transform() [1/2]

void JGEOMETRY3D::JPosition3D::transform ( const JRotation3D & R, const JVector3D & pos )

inlineinherited

Transform position.

The final position is obtained as follows:

1. rotation of the position according matrix R;
2. offset position with pos;
3. rotation of position around z-axis, such that final position lies in x-z plane;

Parameters

R	rotation matrix
pos	position of origin (after rotation)

Definition at line 331 of file JPosition3D.hh.

    {
      // rotate geometry to system with particle direction along z-axis
 
      rotate(R);
 
      // offset with respect to origin
 
      sub(pos);
 
      // rotate geometry to x-z plane
 
      __x = sqrt(__x*__x + __y*__y);
      __y = 0.0;
    }

transform() [2/2]

JVector3D & JGEOMETRY3D::JVector3D::transform ( const JMatrix3D & T )

inlineinherited

Transform.

Parameters

T

matrix

Returns

this vector

Definition at line 206 of file JVector3D.hh.

    {
      T.transform(__x, __y, __z);
 
      return *this;
    }

transform_back()

void JGEOMETRY3D::JPosition3D::transform_back ( const JRotation3D & R, const JVector3D & pos )

inlineinherited

Transform back position.

The final position is obtained as follows:

1. offset position with position pos;
2. rotation of postion according matrix R;

Parameters

R	rotation matrix
pos	position of origin (before rotation)

Definition at line 359 of file JPosition3D.hh.

    {
      // offset with respect to origin
 
      add(pos);
 
      // rotate back geometry to system with particle direction along z-axis
 
      rotate_back(R);
    }

getDot() [1/4]

double JGEOMETRY3D::JPosition3D::getDot ( const JAngle3D & angle ) const

inlineinherited

Get dot product.

Parameters

angle

angle

Returns

dot product

Definition at line 378 of file JPosition3D.hh.

    {
      return
        getX() * angle.getDX() +
        getY() * angle.getDY() +
        getZ() * angle.getDZ();
    }

getDot() [2/4]

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3D & dir ) const

inlineinherited

Get dot product.

Parameters

dir

direction

Returns

dot product

Definition at line 393 of file JPosition3D.hh.

    {
      return
        getX() * dir.getDX() +
        getY() * dir.getDY() +
        getZ() * dir.getDZ();
    }

getDot() [3/4]

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3Z & dir ) const

inlineinherited

Get dot product.

Parameters

dir

direction

Returns

dot product

Definition at line 408 of file JPosition3D.hh.

    {
      return
        getX() * dir.getDX() +
        getY() * dir.getDY() +
        getZ() * dir.getDZ();
    }

getDot() [4/4]

double JGEOMETRY3D::JVector3D::getDot ( const JVector3D & vector ) const

inlineinherited

Get dot product.

Parameters

vector

vector

Returns

dot product

Definition at line 282 of file JVector3D.hh.

    {
      return
        getX() * vector.getX() +
        getY() * vector.getY() +
        getZ() * vector.getZ();
    }

operator JVector2D()

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns

JVector2D

Definition at line 83 of file JVector3D.hh.

    {
      return JVector2D(this->getX(), this->getY());
    }

getX()

double JGEOMETRY3D::JVector3D::getX ( ) const

inlineinherited

Get x position.

Returns

x position

Definition at line 94 of file JVector3D.hh.

    { 
      return __x;
    }

getY()

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns

y position

Definition at line 104 of file JVector3D.hh.

    { 
      return __y;
    }

getZ()

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns

z position

Definition at line 115 of file JVector3D.hh.

    { 
      return __z;
    }

negate()

JVector3D & JGEOMETRY3D::JVector3D::negate ( )

inlineinherited

Negate vector.

Returns

this vector

Definition at line 126 of file JVector3D.hh.

    {
      __x = -__x;
      __y = -__y;
      __z = -__z;
 
      return *this;
    }

add()

JVector3D & JGEOMETRY3D::JVector3D::add ( const JVector3D & vector )

inlineinherited

Add vector.

Parameters

vector

vector

Returns

this vector

Definition at line 142 of file JVector3D.hh.

    {
      __x += vector.getX();
      __y += vector.getY();
      __z += vector.getZ();
 
      return *this;
    }

sub()

JVector3D & JGEOMETRY3D::JVector3D::sub ( const JVector3D & vector )

inlineinherited

Subtract vector.

Parameters

vector

vector

Returns

this vector

Definition at line 158 of file JVector3D.hh.

    {
      __x -= vector.getX();
      __y -= vector.getY();
      __z -= vector.getZ();
 
      return *this;
    }

mul() [1/2]

JVector3D & JGEOMETRY3D::JVector3D::mul ( const double factor )

inlineinherited

Scale vector.

Parameters

factor

multiplication factor

Returns

this vector

Definition at line 174 of file JVector3D.hh.

    {
      __x *= factor;
      __y *= factor;
      __z *= factor;
 
      return *this;
    }

mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

div()

JVector3D & JGEOMETRY3D::JVector3D::div ( const double factor )

inlineinherited

Scale vector.

Parameters

factor

division factor

Returns

this vector

Definition at line 190 of file JVector3D.hh.

    {
      __x /= factor;
      __y /= factor;
      __z /= factor;
 
      return *this;
    }

equals()

bool JGEOMETRY3D::JVector3D::equals ( const JVector3D & vector, const double precision = std::numeric_limits<double>::min() ) const

inlineinherited

Check equality.

Parameters

vector	vector
precision	precision

Returns

true if vectors are equal; else false

Definition at line 221 of file JVector3D.hh.

    {
      return (fabs(getX() - vector.getX()) <= precision &&
              fabs(getY() - vector.getY()) <= precision &&
              fabs(getZ() - vector.getZ()) <= precision);
    }

getLengthSquared()

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns

square of length

Definition at line 235 of file JVector3D.hh.

    { 
      return getX()*getX() + getY()*getY() + getZ()*getZ();
    }

getLength() [2/2]

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns

length

Definition at line 246 of file JVector3D.hh.

    { 
      return sqrt(getLengthSquared());
    }

getDistanceSquared()

double JGEOMETRY3D::JVector3D::getDistanceSquared ( const JVector3D & pos ) const

inlineinherited

Get squared of distance to point.

Parameters

pos

position

Returns

square of distance

Definition at line 258 of file JVector3D.hh.

    {
      return JVector3D(pos).sub(*this).getLengthSquared();
    }

getDistance() [2/2]

double JGEOMETRY3D::JVector3D::getDistance ( const JVector3D & pos ) const

inlineinherited

Get distance to point.

Parameters

pos

position

Returns

distance

Definition at line 270 of file JVector3D.hh.

    {
      return sqrt(getDistanceSquared(pos));
    }

getCross()

JVector3D & JGEOMETRY3D::JVector3D::getCross ( const JVector3D & first, const JVector3D & second )

inlineinherited

Get cross product.

Note that this vector should not overlap with the first or second vector,

Parameters

first	first vector
second	second vector

Returns

this vector

Definition at line 299 of file JVector3D.hh.

    {
      __x = first .getY() * second.getZ()  -  second.getY() * first .getZ();
      __y = second.getX() * first .getZ()  -  first .getX() * second.getZ();
      __z = first .getX() * second.getY()  -  second.getX() * first .getY();
 
      return *this;
    }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const JString & string )

friend

Write string parameters to output stream.

Parameters

out	output stream
string	string

Returns

output stream

Definition at line 463 of file JGeometry.hh.

      {
        using namespace std;
 
        for (size_t i = 0; i != string.size(); ++i) {
          if (string.hasFloor(i)) {
            out << setw(2)    << i              << ' ' 
                << FIXED(7,3) << string[i]      << " | "
                << string.getPosition(i)        << ' ' 
                << string.mechanics             << endl;
          }
        }
 
        return out;
      }

Member Data Documentation

PRECISION_M

double JACOUSTICS::JGEOMETRY::JString::PRECISION_M = 1.0e-4

staticconstexpr

precision of height evaluation [m]

Definition at line 148 of file JGeometry.hh.

hydrophone

JPosition3D JACOUSTICS::JGEOMETRY::JString::hydrophone

Hydrophone.

The position of the hydrophone is relative to the reference position of the string.

Definition at line 485 of file JGeometry.hh.

has_hydrophone

bool JACOUSTICS::JGEOMETRY::JString::has_hydrophone

Definition at line 486 of file JGeometry.hh.

mechanics

JMechanics JACOUSTICS::JGEOMETRY::JString::mechanics

private

Mechanical data.

Definition at line 492 of file JGeometry.hh.

__x

double JGEOMETRY3D::JVector3D::__x

protectedinherited

Definition at line 310 of file JVector3D.hh.

__y

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 311 of file JVector3D.hh.

__z

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 312 of file JVector3D.hh.

---

The documentation for this struct was generated from the following file:

• JGeometry.hh