Jpp  18.0.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | Friends | List of all members
JACOUSTICS::JGEOMETRY::JString Struct Reference

String geometry. More...

#include <JGeometry.hh>

Inheritance diagram for JACOUSTICS::JGEOMETRY::JString:
JGEOMETRY3D::JPosition3D std::vector< JFloor > JGEOMETRY3D::JVector3D JMATH::JMath< JFirst_t, JSecond_t >

Public Member Functions

 JString ()
 Default constructor. More...
 
 JString (const JVector3D &position, const JMechanics &mechanics)
 Constructor. More...
 
template<class T >
 JString (const JVector3D &position, const JMechanics &mechanics, T __begin, T __end)
 Constructor. More...
 
const JMechanicsgetMechanics () const
 Get mechanical model parameters. More...
 
JFlooroperator[] (size_t floor)
 Get floor data. More...
 
bool hasFloor (size_t floor) const
 Check if this string has given floor. More...
 
double getHeight (const size_t floor) const
 Get height of given floor. More...
 
JPosition3D getPosition (const JMODEL::JString &parameters, const size_t floor) const
 Get position of given floor according to given string model parameters. More...
 
JPosition3D getPosition (const size_t floor) const
 Get position of given floor according to default string model parameters. More...
 
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. More...
 
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. More...
 
const JPosition3DgetPosition () const
 Get position. More...
 
JPosition3DgetPosition ()
 Get position. More...
 
void setPosition (const JVector3D &pos)
 Set position. More...
 
 operator JAngle3D () const
 Type conversion operator. More...
 
 operator JVersor3D () const
 Type conversion operator. More...
 
JPosition3Drotate (const JRotation3D &R)
 Rotate. More...
 
JPosition3Drotate (const JRotation3X &R)
 Rotate around X-axis. More...
 
JPosition3Drotate (const JRotation3Y &R)
 Rotate around Y-axis. More...
 
JPosition3Drotate (const JRotation3Z &R)
 Rotate around Z-axis. More...
 
JPosition3Drotate (const JQuaternion3D &Q)
 Rotate. More...
 
JPosition3Drotate_back (const JRotation3D &R)
 Rotate back. More...
 
JPosition3Drotate_back (const JRotation3X &R)
 Rotate back around X-axis. More...
 
JPosition3Drotate_back (const JRotation3Y &R)
 Rotate back around Y-axis. More...
 
JPosition3Drotate_back (const JRotation3Z &R)
 Rotate back around Z-axis. More...
 
JPosition3Drotate_back (const JQuaternion3D &Q)
 Rotate back. More...
 
void transform (const JRotation3D &R, const JVector3D &pos)
 Transform position. More...
 
JVector3Dtransform (const JMatrix3D &T)
 Transform. More...
 
void transform_back (const JRotation3D &R, const JVector3D &pos)
 Transform back position. More...
 
double getDot (const JAngle3D &angle) const
 Get dot product. More...
 
double getDot (const JVersor3D &dir) const
 Get dot product. More...
 
double getDot (const JVersor3Z &dir) const
 Get dot product. More...
 
double getDot (const JVector3D &vector) const
 Get dot product. More...
 
 operator JVector2D () const
 Type conversion operator. More...
 
double getX () const
 Get x position. More...
 
double getY () const
 Get y position. More...
 
double getZ () const
 Get z position. More...
 
JVector3Dnegate ()
 Negate vector. More...
 
JVector3Dadd (const JVector3D &vector)
 Add vector. More...
 
JVector3Dsub (const JVector3D &vector)
 Subtract vector. More...
 
JVector3Dmul (const double factor)
 Scale vector. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 
JVector3Ddiv (const double factor)
 Scale vector. More...
 
bool equals (const JVector3D &vector, const double precision=std::numeric_limits< double >::min()) const
 Check equality. More...
 
double getLengthSquared () const
 Get length squared. More...
 
double getLength () const
 Get length. More...
 
double getDistanceSquared (const JVector3D &pos) const
 Get squared of distance to point. More...
 
double getDistance (const JVector3D &pos) const
 Get distance to point. More...
 
JVector3DgetCross (const JVector3D &first, const JVector3D &second)
 Get cross product. More...
 

Static Public Member Functions

static double getLength (const JMODEL::JString &parameters, const JMechanics &mechanics, const double height)
 Get approximate length of string. More...
 
static double getHeight (const JMODEL::JString &parameters, const JMechanics &mechanics, const double length, const double precision=PRECISION_M)
 Get approximate height of string. More...
 
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. More...
 

Public Attributes

JPosition3D hydrophone
 Hydrophone. More...
 
bool has_hydrophone
 

Static Public Attributes

static constexpr double PRECISION_M = 1.0e-4
 precision of height evaluation [m] More...
 

Protected Attributes

JMechanics mechanics
 Mechanical data. More...
 
double __x
 
double __y
 
double __z
 

Friends

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

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 mounted in 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 121 of file JGeometry.hh.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 207 of file JGeometry.hh.

207  :
208  has_hydrophone(false)
209  {}
JACOUSTICS::JGEOMETRY::JString::JString ( const JVector3D position,
const JMechanics mechanics 
)
inline

Constructor.

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

Parameters
positionposition
mechanicsmechanical model parameters

Definition at line 221 of file JGeometry.hh.

222  :
223  JPosition3D(position),
224  has_hydrophone(false),
225  mechanics(mechanics)
226  {}
JMechanics mechanics
Mechanical data.
Definition: JGeometry.hh:467
JPosition3D()
Default constructor.
Definition: JPosition3D.hh:48
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 calculated.

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
positionposition
mechanicsmechanical model parameters
__beginbegin of optical modules
__endend of optical modules

Definition at line 251 of file JGeometry.hh.

254  :
255  JPosition3D(position),
256  has_hydrophone(false),
257  mechanics(mechanics)
258  {
259  for (T i = __begin; i != __end; ++i) {
260  (*this)[i->getFloor()] = this->getDistance(i->getPosition() + JDETECTOR::getPiezoPosition());
261  }
262  }
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.
Definition: JGeometry.hh:375
do set_variable OUTPUT_DIRECTORY $WORKDIR T
JMechanics mechanics
Mechanical data.
Definition: JGeometry.hh:467
JPosition3D getPiezoPosition()
Get relative position of piezo in optical module.
JPosition3D()
Default constructor.
Definition: JPosition3D.hh:48

Member Function Documentation

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

Get approximate length of string.

Parameters
parametersparameters
mechanicsmechanics
heightheight
Returns
length

Definition at line 139 of file JGeometry.hh.

142  {
143  const double t2 = parameters.getLengthSquared();
144 
145  return 0.5*t2*mechanics.b * log(1.0 - mechanics.a*height) + sqrt(1.0 + t2) * height;
146  }
double a
0 &lt;= a &lt; (maximal height)⁻1; [m^-1]
Definition: JMechanics.hh:102
double getLengthSquared() const
Get length squared.
double b
0 &lt;= b; [m]
Definition: JMechanics.hh:103
then set_variable DIR else fatal Wrong number of arguments fi for INPUT_FILE in ls rt $DIR stage * log
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
parametersparameters
mechanicsmechanics
lengthlength
precisionprecision
Returns
height

Definition at line 158 of file JGeometry.hh.

162  {
163  const size_t MAXIMUM_NUMBER_OF_ITERATIONS = 10;
164 
165  const double ts = 0.5 * parameters.getLengthSquared();
166 
167  double z = length; // start value
168 
169  for (size_t i = 0; i != MAXIMUM_NUMBER_OF_ITERATIONS; ++i) {
170 
171  const double ls = getLength(parameters, mechanics, z);
172 
173  if (fabs(ls - length) <= precision) {
174  break;
175  }
176 
177  z -= (ls - length) / (1.0 + ts * (1.0 - mechanics.a*mechanics.b / (1.0 - mechanics.a*z)));
178  }
179 
180  return z;
181  }
double a
0 &lt;= a &lt; (maximal height)⁻1; [m^-1]
Definition: JMechanics.hh:102
double getLengthSquared() const
Get length squared.
double getLength() const
Get length.
Definition: JVector3D.hh:246
double b
0 &lt;= b; [m]
Definition: JMechanics.hh:103
Auxiliary data structure to list files in directory.
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
parametersparameters
mechanicsmechanics
heightheight
Returns
position

Definition at line 191 of file JGeometry.hh.

194  {
195  const double h1 = height * (1.0 + parameters.vs);
196  const double z1 = mechanics.getHeight(h1);
197 
198  return JPosition3D(parameters.tx * z1 + parameters.tx2 * h1*h1,
199  parameters.ty * z1 + parameters.ty2 * h1*h1,
200  getHeight(parameters, mechanics, h1));
201  }
static double getHeight(const JMODEL::JString &parameters, const JMechanics &mechanics, const double length, const double precision=PRECISION_M)
Get approximate height of string.
Definition: JGeometry.hh:158
double getHeight(const double height) const
Get effective height for given actual height.
Definition: JMechanics.hh:70
JPosition3D()
Default constructor.
Definition: JPosition3D.hh:48
const JMechanics& JACOUSTICS::JGEOMETRY::JString::getMechanics ( ) const
inline

Get mechanical model parameters.

Returns
mechanical model parameters

Definition at line 270 of file JGeometry.hh.

271  {
272  return mechanics;
273  }
JMechanics mechanics
Mechanical data.
Definition: JGeometry.hh:467
JFloor& JACOUSTICS::JGEOMETRY::JString::operator[] ( size_t  floor)
inline

Get floor data.

Parameters
floorfloor number
Returns
floor data

Definition at line 282 of file JGeometry.hh.

283  {
284  if (floor >= this->size()) {
285  this->resize(floor + 1);
286  }
287 
288  return static_cast<std::vector<JFloor>&>(*this)[floor];
289  }
bool JACOUSTICS::JGEOMETRY::JString::hasFloor ( size_t  floor) const
inline

Check if this string has given floor.

Parameters
floorfloor
Returns
true if floor present; else false

Definition at line 298 of file JGeometry.hh.

299  {
300  if (floor == 0)
301  return has_hydrophone;
302  else
303  return (floor < this->size());
304  }
double JACOUSTICS::JGEOMETRY::JString::getHeight ( const size_t  floor) const
inline

Get height of given floor.

Parameters
floorfloor
Returns
height

Definition at line 313 of file JGeometry.hh.

314  {
315  if (floor == 0) {
316 
317  if (has_hydrophone) {
318  return hydrophone.getZ();
319  }
320 
321  } else if (floor < this->size()) {
322 
323  return (*this)[floor].getHeight();
324  }
325 
326  THROW(JValueOutOfRange, "Invalid floor " << floor);
327  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
JPosition3D hydrophone
Hydrophone.
Definition: JGeometry.hh:460
Exception for accessing a value in a collection that is outside of its range.
Definition: JException.hh:162
double getZ() const
Get z position.
Definition: JVector3D.hh:115
JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const JMODEL::JString parameters,
const size_t  floor 
) const
inline

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

Parameters
parametersparameters
floorfloor
Returns
position

Definition at line 337 of file JGeometry.hh.

339  {
340  if (floor == 0) {
341 
342  if (has_hydrophone) {
343  return this->getPosition() + hydrophone.getPosition();
344  }
345 
346  } else if (floor < this->size()) {
347 
348  return this->getPosition() + getPosition(parameters, mechanics, (*this)[floor].getHeight());
349  }
350 
351  THROW(JValueOutOfRange, "Invalid floor " << floor);
352  }
static double getHeight(const JMODEL::JString &parameters, const JMechanics &mechanics, const double length, const double precision=PRECISION_M)
Get approximate height of string.
Definition: JGeometry.hh:158
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
const JPosition3D & getPosition() const
Get position.
Definition: JPosition3D.hh:130
JPosition3D hydrophone
Hydrophone.
Definition: JGeometry.hh:460
JMechanics mechanics
Mechanical data.
Definition: JGeometry.hh:467
Exception for accessing a value in a collection that is outside of its range.
Definition: JException.hh:162
JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const size_t  floor) const
inline

Get position of given floor according to default string model parameters.

Parameters
floorfloor
Returns
position

Definition at line 361 of file JGeometry.hh.

362  {
363  return getPosition(JMODEL::JString(), floor);
364  }
const JPosition3D & getPosition() const
Get position.
Definition: JPosition3D.hh:130
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
parametersparameters
positionposition
floorfloor
Returns
distance

Definition at line 375 of file JGeometry.hh.

378  {
379  return this->getPosition(parameters, floor).getDistance(position);
380  }
double getDistance(const JVector3D &pos) const
Get distance to point.
Definition: JVector3D.hh:270
const JPosition3D & getPosition() const
Get position.
Definition: JPosition3D.hh:130
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
parametersparameters
positionposition
floorfloor
Returns
gradient

Definition at line 391 of file JGeometry.hh.

394  {
395  if (floor == 0) {
396 
397  return JMODEL::JString();
398 
399  } else if (floor < this->size()) {
400 
401  const JPosition3D pos = this->getPosition(parameters, floor);
402  const double height = (*this)[floor].getHeight();
403  const double h1 = height * (1.0 + parameters.vs);
404  const double z1 = this->mechanics.getHeight(h1);
405 
406  const double tx = parameters.tx;
407  const double ty = parameters.ty;
408  const double tz = sqrt(1.0 - tx*tx - ty*ty);
409 
410  const double dx = pos.getX() - position.getX();
411  const double dy = pos.getY() - position.getY();
412  const double dz = pos.getZ() - position.getZ();
413 
414  const double D = sqrt(dx*dx + dy*dy + dz*dz);
415  const double vw = 1.0 - mechanics.a * mechanics.b / (1.0 - mechanics.a*h1);
416  const double vs = 1.0 + 0.5 * parameters.getLengthSquared() * vw;
417 
418  return JMODEL::JString(z1 * dx / D - height * (tx / tz) * dz / D,
419  z1 * dy / D - height * (ty / tz) * dz / D,
420  h1*h1 * dx / D,
421  h1*h1 * dy / D,
422  height * vw * (tx * dx + ty * dy) / D + h1 * (dz / vs) / D);
423 
424  } else {
425 
426  THROW(JValueOutOfRange, "Invalid floor " << floor);
427  }
428  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
std::vector< double > vs
double a
0 &lt;= a &lt; (maximal height)⁻1; [m^-1]
Definition: JMechanics.hh:102
double getHeight(const double height) const
Get effective height for given actual height.
Definition: JMechanics.hh:70
double getLengthSquared() const
Get length squared.
double getY() const
Get y position.
Definition: JVector3D.hh:104
const JPosition3D & getPosition() const
Get position.
Definition: JPosition3D.hh:130
double b
0 &lt;= b; [m]
Definition: JMechanics.hh:103
JMechanics mechanics
Mechanical data.
Definition: JGeometry.hh:467
double getX() const
Get x position.
Definition: JVector3D.hh:94
Data structure for position in three dimensions.
Definition: JPosition3D.hh:36
Exception for accessing a value in a collection that is outside of its range.
Definition: JException.hh:162
do echo Generating $dir eval D
Definition: JDrawLED.sh:53
double getZ() const
Get z position.
Definition: JVector3D.hh:115
const JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( ) const
inlineinherited

Get position.

Returns
position

Definition at line 130 of file JPosition3D.hh.

131  {
132  return static_cast<const JPosition3D&>(*this);
133  }
Data structure for position in three dimensions.
Definition: JPosition3D.hh:36
JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( )
inlineinherited

Get position.

Returns
position

Definition at line 141 of file JPosition3D.hh.

142  {
143  return static_cast<JPosition3D&>(*this);
144  }
Data structure for position in three dimensions.
Definition: JPosition3D.hh:36
void JGEOMETRY3D::JPosition3D::setPosition ( const JVector3D pos)
inlineinherited

Set position.

Parameters
posposition

Definition at line 152 of file JPosition3D.hh.

153  {
154  static_cast<JVector3D&>(*this) = pos;
155  }
Data structure for vector in three dimensions.
Definition: JVector3D.hh:34
JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const
inlineinherited

Type conversion operator.

Returns
angle

Definition at line 163 of file JPosition3D.hh.

164  {
165  return JAngle3D(getX(), getY(), getZ());
166  }
Data structure for angles in three dimensions.
Definition: JAngle3D.hh:33
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const
inlineinherited

Type conversion operator.

Returns
direction

Definition at line 174 of file JPosition3D.hh.

175  {
176  return JVersor3D(getX(), getY(), getZ());
177  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
Data structure for normalised vector in three dimensions.
Definition: JVersor3D.hh:26
double getZ() const
Get z position.
Definition: JVector3D.hh:115
JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3D R)
inlineinherited

Rotate.

Parameters
Rrotation matrix
Returns
this position

Definition at line 186 of file JPosition3D.hh.

187  {
188  R.rotate(__x, __y, __z);
189 
190  return *this;
191  }
void rotate(double &__x, double &__y, double &__z) const
Rotate.
Definition: JRotation3D.hh:336
JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3X R)
inlineinherited

Rotate around X-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 214 of file JPosition3D.hh.

215  {
216  R.rotate(__y, __z);
217 
218  return *this;
219  }
void rotate(double &__x, double &__y) const
Rotate.
Definition: JRotation2D.hh:96
JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Y R)
inlineinherited

Rotate around Y-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 242 of file JPosition3D.hh.

243  {
244  R.rotate(__x, __z);
245 
246  return *this;
247  }
void rotate(double &__x, double &__y) const
Rotate.
Definition: JRotation2D.hh:96
JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Z R)
inlineinherited

Rotate around Z-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 270 of file JPosition3D.hh.

271  {
272  R.rotate(__x, __y);
273 
274  return *this;
275  }
void rotate(double &__x, double &__y) const
Rotate.
Definition: JRotation2D.hh:96
JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JQuaternion3D Q)
inlineinherited

Rotate.

Parameters
Qquaternion
Returns
this position

Definition at line 298 of file JPosition3D.hh.

299  {
300  Q.rotate(__x, __y, __z);
301 
302  return *this;
303  }
void rotate(double &__x, double &__y, double &__z) const
Rotate.
JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3D R)
inlineinherited

Rotate back.

Parameters
Rrotation matrix
Returns
this position

Definition at line 200 of file JPosition3D.hh.

201  {
202  R.rotate_back(__x, __y, __z);
203 
204  return *this;
205  }
void rotate_back(double &__x, double &__y, double &__z) const
Rotate back.
Definition: JRotation3D.hh:355
JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3X R)
inlineinherited

Rotate back around X-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 228 of file JPosition3D.hh.

229  {
230  R.rotate_back(__y, __z);
231 
232  return *this;
233  }
void rotate_back(double &__x, double &__y) const
Rotate back.
Definition: JRotation2D.hh:112
JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Y R)
inlineinherited

Rotate back around Y-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 256 of file JPosition3D.hh.

257  {
258  R.rotate_back(__x, __z);
259 
260  return *this;
261  }
void rotate_back(double &__x, double &__y) const
Rotate back.
Definition: JRotation2D.hh:112
JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Z R)
inlineinherited

Rotate back around Z-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 284 of file JPosition3D.hh.

285  {
286  R.rotate_back(__x, __y);
287 
288  return *this;
289  }
void rotate_back(double &__x, double &__y) const
Rotate back.
Definition: JRotation2D.hh:112
JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JQuaternion3D Q)
inlineinherited

Rotate back.

Parameters
Qquaternion
Returns
this position

Definition at line 312 of file JPosition3D.hh.

313  {
314  Q.rotate_back(__x, __y, __z);
315 
316  return *this;
317  }
void rotate_back(double &__x, double &__y, double &__z) const
Rotate back.
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
Rrotation matrix
posposition of origin (after rotation)

Definition at line 331 of file JPosition3D.hh.

333  {
334  // rotate geometry to system with particle direction along z-axis
335 
336  rotate(R);
337 
338  // offset with respect to origin
339 
340  sub(pos);
341 
342  // rotate geometry to x-z plane
343 
344  __x = sqrt(__x*__x + __y*__y);
345  __y = 0.0;
346  }
JVector3D & sub(const JVector3D &vector)
Subtract vector.
Definition: JVector3D.hh:158
JPosition3D & rotate(const JRotation3D &R)
Rotate.
Definition: JPosition3D.hh:186
JVector3D& JGEOMETRY3D::JVector3D::transform ( const JMatrix3D T)
inlineinherited

Transform.

Parameters
Tmatrix
Returns
this vector

Definition at line 206 of file JVector3D.hh.

207  {
208  T.transform(__x, __y, __z);
209 
210  return *this;
211  }
do set_variable OUTPUT_DIRECTORY $WORKDIR T
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
Rrotation matrix
posposition of origin (before rotation)

Definition at line 359 of file JPosition3D.hh.

361  {
362  // offset with respect to origin
363 
364  add(pos);
365 
366  // rotate back geometry to system with particle direction along z-axis
367 
368  rotate_back(R);
369  }
JPosition3D & rotate_back(const JRotation3D &R)
Rotate back.
Definition: JPosition3D.hh:200
JVector3D & add(const JVector3D &vector)
Add vector.
Definition: JVector3D.hh:142
double JGEOMETRY3D::JPosition3D::getDot ( const JAngle3D angle) const
inlineinherited

Get dot product.

Parameters
angleangle
Returns
dot product

Definition at line 378 of file JPosition3D.hh.

379  {
380  return
381  getX() * angle.getDX() +
382  getY() * angle.getDY() +
383  getZ() * angle.getDZ();
384  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
double getDX() const
Get x direction.
Definition: JAngle3D.hh:108
double getDZ() const
Get z direction.
Definition: JAngle3D.hh:130
double getDY() const
Get y direction.
Definition: JAngle3D.hh:119
double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3D dir) const
inlineinherited

Get dot product.

Parameters
dirdirection
Returns
dot product

Definition at line 393 of file JPosition3D.hh.

394  {
395  return
396  getX() * dir.getDX() +
397  getY() * dir.getDY() +
398  getZ() * dir.getDZ();
399  }
double getDY() const
Get y direction.
Definition: JVersor3D.hh:106
double getDX() const
Get x direction.
Definition: JVersor3D.hh:95
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
double getDZ() const
Get z direction.
Definition: JVersor3D.hh:117
double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3Z dir) const
inlineinherited

Get dot product.

Parameters
dirdirection
Returns
dot product

Definition at line 408 of file JPosition3D.hh.

409  {
410  return
411  getX() * dir.getDX() +
412  getY() * dir.getDY() +
413  getZ() * dir.getDZ();
414  }
double getDY() const
Get y direction.
Definition: JVersor3Z.hh:158
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getDX() const
Get x direction.
Definition: JVersor3Z.hh:147
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getDZ() const
Get z direction.
Definition: JVersor3Z.hh:169
double getZ() const
Get z position.
Definition: JVector3D.hh:115
double JGEOMETRY3D::JVector3D::getDot ( const JVector3D vector) const
inlineinherited

Get dot product.

Parameters
vectorvector
Returns
dot product

Definition at line 282 of file JVector3D.hh.

283  {
284  return
285  getX() * vector.getX() +
286  getY() * vector.getY() +
287  getZ() * vector.getZ();
288  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
JGEOMETRY3D::JVector3D::operator JVector2D ( ) const
inlineinherited

Type conversion operator.

Returns
JVector2D

Definition at line 83 of file JVector3D.hh.

84  {
85  return JVector2D(this->getX(), this->getY());
86  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double JGEOMETRY3D::JVector3D::getX ( ) const
inlineinherited

Get x position.

Returns
x position

Definition at line 94 of file JVector3D.hh.

95  {
96  return __x;
97  }
double JGEOMETRY3D::JVector3D::getY ( ) const
inlineinherited

Get y position.

Returns
y position

Definition at line 104 of file JVector3D.hh.

105  {
106  return __y;
107  }
double JGEOMETRY3D::JVector3D::getZ ( ) const
inlineinherited

Get z position.

Returns
z position

Definition at line 115 of file JVector3D.hh.

116  {
117  return __z;
118  }
JVector3D& JGEOMETRY3D::JVector3D::negate ( )
inlineinherited

Negate vector.

Returns
this vector

Definition at line 126 of file JVector3D.hh.

127  {
128  __x = -__x;
129  __y = -__y;
130  __z = -__z;
131 
132  return *this;
133  }
JVector3D& JGEOMETRY3D::JVector3D::add ( const JVector3D vector)
inlineinherited

Add vector.

Parameters
vectorvector
Returns
this vector

Definition at line 142 of file JVector3D.hh.

143  {
144  __x += vector.getX();
145  __y += vector.getY();
146  __z += vector.getZ();
147 
148  return *this;
149  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
JVector3D& JGEOMETRY3D::JVector3D::sub ( const JVector3D vector)
inlineinherited

Subtract vector.

Parameters
vectorvector
Returns
this vector

Definition at line 158 of file JVector3D.hh.

159  {
160  __x -= vector.getX();
161  __y -= vector.getY();
162  __z -= vector.getZ();
163 
164  return *this;
165  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
JVector3D& JGEOMETRY3D::JVector3D::mul ( const double  factor)
inlineinherited

Scale vector.

Parameters
factormultiplication factor
Returns
this vector

Definition at line 174 of file JVector3D.hh.

175  {
176  __x *= factor;
177  __y *= factor;
178  __z *= factor;
179 
180  return *this;
181  }
template<class JFirst_t, class JSecond_t = JNullType>
JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t &  object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 354 of file JMath.hh.

355  {
356  return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
357  }
JVector3D& JGEOMETRY3D::JVector3D::div ( const double  factor)
inlineinherited

Scale vector.

Parameters
factordivision factor
Returns
this vector

Definition at line 190 of file JVector3D.hh.

191  {
192  __x /= factor;
193  __y /= factor;
194  __z /= factor;
195 
196  return *this;
197  }
bool JGEOMETRY3D::JVector3D::equals ( const JVector3D vector,
const double  precision = std::numeric_limits<double>::min() 
) const
inlineinherited

Check equality.

Parameters
vectorvector
precisionprecision
Returns
true if vectors are equal; else false

Definition at line 221 of file JVector3D.hh.

223  {
224  return (fabs(getX() - vector.getX()) <= precision &&
225  fabs(getY() - vector.getY()) <= precision &&
226  fabs(getZ() - vector.getZ()) <= precision);
227  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const
inlineinherited

Get length squared.

Returns
square of length

Definition at line 235 of file JVector3D.hh.

236  {
237  return getX()*getX() + getY()*getY() + getZ()*getZ();
238  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115
double JGEOMETRY3D::JVector3D::getLength ( ) const
inlineinherited

Get length.

Returns
length

Definition at line 246 of file JVector3D.hh.

247  {
248  return sqrt(getLengthSquared());
249  }
double getLengthSquared() const
Get length squared.
Definition: JVector3D.hh:235
double JGEOMETRY3D::JVector3D::getDistanceSquared ( const JVector3D pos) const
inlineinherited

Get squared of distance to point.

Parameters
posposition
Returns
square of distance

Definition at line 258 of file JVector3D.hh.

259  {
260  return JVector3D(pos).sub(*this).getLengthSquared();
261  }
JVector3D()
Default constructor.
Definition: JVector3D.hh:41
double JGEOMETRY3D::JVector3D::getDistance ( const JVector3D pos) const
inlineinherited

Get distance to point.

Parameters
posposition
Returns
distance

Definition at line 270 of file JVector3D.hh.

271  {
272  return sqrt(getDistanceSquared(pos));
273  }
double getDistanceSquared(const JVector3D &pos) const
Get squared of distance to point.
Definition: JVector3D.hh:258
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
firstfirst vector
secondsecond vector
Returns
this vector

Definition at line 299 of file JVector3D.hh.

301  {
302  __x = first .getY() * second.getZ() - second.getY() * first .getZ();
303  __y = second.getX() * first .getZ() - first .getX() * second.getZ();
304  __z = first .getX() * second.getY() - second.getX() * first .getY();
305 
306  return *this;
307  }
double getY() const
Get y position.
Definition: JVector3D.hh:104
double getX() const
Get x position.
Definition: JVector3D.hh:94
double getZ() const
Get z position.
Definition: JVector3D.hh:115

Friends And Related Function Documentation

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

Write string parameters to output stream.

Parameters
outoutput stream
stringstring
Returns
output stream

Definition at line 438 of file JGeometry.hh.

439  {
440  using namespace std;
441 
442  for (size_t i = 0; i != string.size(); ++i) {
443  if (string.hasFloor(i)) {
444  out << setw(2) << i << ' '
445  << FIXED(7,3) << string[i] << " | "
446  << string.getPosition(i) << ' '
447  << string.mechanics << endl;
448  }
449  }
450 
451  return out;
452  }
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:446
bool hasFloor(size_t floor) const
Check if this string has given floor.
Definition: JGeometry.hh:298

Member Data Documentation

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

precision of height evaluation [m]

Definition at line 129 of file JGeometry.hh.

JPosition3D JACOUSTICS::JGEOMETRY::JString::hydrophone

Hydrophone.

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

Definition at line 460 of file JGeometry.hh.

bool JACOUSTICS::JGEOMETRY::JString::has_hydrophone

Definition at line 461 of file JGeometry.hh.

JMechanics JACOUSTICS::JGEOMETRY::JString::mechanics
protected

Mechanical data.

Definition at line 467 of file JGeometry.hh.

double JGEOMETRY3D::JVector3D::__x
protectedinherited

Definition at line 310 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y
protectedinherited

Definition at line 311 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z
protectedinherited

Definition at line 312 of file JVector3D.hh.


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