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.

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]

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()

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/3]

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/3]

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/3]

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()

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);
        }       
      }

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

constexpr 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.

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

JGeometry.hh

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JString() [1/3]

◆ JString() [2/3]

◆ JString() [3/3]

Member Function Documentation

◆ getLength()

◆ getHeight() [1/2]

◆ getPosition() [1/3]

◆ getMechanics()

◆ operator[]()

◆ hasFloor()

◆ getHeight() [2/2]

◆ getPosition() [2/3]

◆ getPosition() [3/3]

◆ getDistance()

◆ getGradient()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ PRECISION_M

◆ hydrophone

◆ has_hydrophone

◆ mechanics