Jpp test-rotations-old
the software that should make you happy
Loading...
Searching...
No Matches
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.
 
 JString (const JVector3D &position, const JMechanics &mechanics)
 Constructor.
 
template<class T >
 JString (const JVector3D &position, const JMechanics &mechanics, T __begin, T __end)
 Constructor.
 
const JMechanicsgetMechanics () const
 Get mechanical model parameters.
 
JFlooroperator[] (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 JPosition3DgetPosition () const
 Get position.
 
JPosition3DgetPosition ()
 Get position.
 
void setPosition (const JVector3D &pos)
 Set position.
 
 operator JAngle3D () const
 Type conversion operator.
 
 operator JVersor3D () const
 Type conversion operator.
 
JPosition3Drotate (const JRotation3D &R)
 Rotate.
 
JPosition3Drotate (const JRotation3X &R)
 Rotate around X-axis.
 
JPosition3Drotate (const JRotation3Y &R)
 Rotate around Y-axis.
 
JPosition3Drotate (const JRotation3Z &R)
 Rotate around Z-axis.
 
JPosition3Drotate (const JQuaternion3D &Q)
 Rotate.
 
JPosition3Drotate_back (const JRotation3D &R)
 Rotate back.
 
JPosition3Drotate_back (const JRotation3X &R)
 Rotate back around X-axis.
 
JPosition3Drotate_back (const JRotation3Y &R)
 Rotate back around Y-axis.
 
JPosition3Drotate_back (const JRotation3Z &R)
 Rotate back around Z-axis.
 
JPosition3Drotate_back (const JQuaternion3D &Q)
 Rotate back.
 
void transform (const JRotation3D &R, const JVector3D &pos)
 Transform position.
 
JVector3Dtransform (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.
 
JVector3Dnegate ()
 Negate vector.
 
JVector3Dadd (const JVector3D &vector)
 Add vector.
 
JVector3Dsub (const JVector3D &vector)
 Subtract vector.
 
JVector3Dmul (const double factor)
 Scale vector.
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object.
 
JVector3Ddiv (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.
 
JVector3DgetCross (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.

231 :
232 has_hydrophone(false)
233 {}

◆ 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
positionposition
mechanicsmechanical model parameters

Definition at line 245 of file JGeometry.hh.

246 :
247 JPosition3D(position),
248 has_hydrophone(false),
250 {}
JPosition3D()
Default constructor.
JMechanics mechanics
Mechanical data.
Definition JGeometry.hh:492

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

Definition at line 275 of file JGeometry.hh.

278 :
279 JPosition3D(position),
280 has_hydrophone(false),
282 {
283 for (T i = __begin; i != __end; ++i) {
284 (*this)[i->getFloor()] = JFloor(this->getDistance(i->getPosition() + JDETECTOR::getPiezoPosition()),
285 JVector2D(i->getX() - this->getX(),
286 i->getY() - this->getY()));
287 }
288 }
Data structure for vector in two dimensions.
Definition JVector2D.hh:34
JPosition3D getPiezoPosition()
Get relative position of piezo in optical module.
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:400

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
parametersparameters
mechanicsmechanics
heightheight
Returns
length

Definition at line 158 of file JGeometry.hh.

161 {
162 const double T2 = parameters.getLengthSquared();
163
164 const double x = 1.0 - mechanics.a*height;
165
166 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);
167 }
double getLengthSquared() const
Get length squared.
double a
0 <= a < (maximal height)⁻1; [m^-1]
double b
0 <= b; [m]

◆ 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
parametersparameters
mechanicsmechanics
lengthlength
precisionprecision
Returns
height

Definition at line 179 of file JGeometry.hh.

183 {
184 const size_t MAXIMUM_NUMBER_OF_ITERATIONS = 10;
185
186 const double T2 = parameters.getLengthSquared();
187
188 double z = length; // start value
189
190 for (size_t i = 0; i != MAXIMUM_NUMBER_OF_ITERATIONS; ++i) {
191
192 const double ls = getLength(parameters, mechanics, z) - length;
193
194 if (fabs(ls) <= precision) {
195 break;
196 }
197
198 const double vs = 1.0 - mechanics.a*mechanics.b / (1.0 - mechanics.a*z);
199
200 z -= ls / (1.0 + 0.5*T2 * vs*vs);
201 }
202
203 return z;
204 }
double getLength() const
Get length.
Definition JVector3D.hh:246
Auxiliary data structure to list files in directory.

◆ 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
parametersparameters
mechanicsmechanics
heightheight
Returns
position

Definition at line 215 of file JGeometry.hh.

218 {
219 const double h1 = height * (1.0 + parameters.vs);
220 const double z1 = mechanics.getHeight(h1);
221
222 return JPosition3D(parameters.tx * z1 + parameters.tx2 * h1*h1,
223 parameters.ty * z1 + parameters.ty2 * h1*h1,
224 getHeight(parameters, mechanics, h1));
225 }
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:179
double getHeight(const double height) const
Get effective height for given actual height.
Definition JMechanics.hh:70

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

297 {
298 return mechanics;
299 }

◆ operator[]()

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

Get floor data.

Parameters
floorfloor number
Returns
floor data

Definition at line 308 of file JGeometry.hh.

309 {
310 if (floor >= this->size()) {
311 this->resize(floor + 1);
312 }
313
314 return static_cast<std::vector<JFloor>&>(*this)[floor];
315 }

◆ hasFloor()

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

Check if this string has receiver at given floor.

Parameters
floorfloor
Returns
true if receiver present; else false

Definition at line 324 of file JGeometry.hh.

325 {
326 if (floor == 0)
327 return has_hydrophone;
328 else
329 return (floor < this->size());
330 }

◆ 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
floorfloor
Returns
height

Definition at line 339 of file JGeometry.hh.

340 {
341 if (!hasFloor(floor)) {
342 THROW(JValueOutOfRange, "Invalid floor " << floor);
343 }
344
345 if (floor == 0)
346 return hydrophone.getZ();
347 else
348 return (*this)[floor].getHeight();
349 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
double getZ() const
Get z position.
Definition JVector3D.hh:115
Exception for accessing a value in a collection that is outside of its range.
JPosition3D hydrophone
Hydrophone.
Definition JGeometry.hh:485
bool hasFloor(size_t floor) const
Check if this string has receiver at given floor.
Definition JGeometry.hh:324

◆ 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
parametersparameters
floorfloor
Returns
position

Definition at line 359 of file JGeometry.hh.

361 {
362 if (!hasFloor(floor)) {
363 THROW(JValueOutOfRange, "Invalid floor " << floor);
364 }
365
366 if (floor == 0)
367 return this->getPosition() + hydrophone.getPosition();
368 else
369 return this->getPosition() + getPosition(parameters, this->mechanics, (*this)[floor].getHeight()) + (*this)[floor].getPosition();
370 }
const JPosition3D & getPosition() const
Get position.
const JPosition3D & getPosition() const
Get position.

◆ getPosition() [3/5]

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

Get position of receiver at given floor.

Parameters
floorfloor
Returns
position

Definition at line 379 of file JGeometry.hh.

380 {
381 if (!hasFloor(floor)) {
382 THROW(JValueOutOfRange, "Invalid floor " << floor);
383 }
384
385 if (floor == 0)
386 return this->getPosition() + hydrophone.getPosition();
387 else
388 return this->getPosition() + JPosition3D(0.0, 0.0, (*this)[floor].getHeight()) + (*this)[floor].getPosition();
389 }

◆ 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
parametersparameters
positionposition
floorfloor
Returns
distance

Definition at line 400 of file JGeometry.hh.

403 {
404 return this->getPosition(parameters, floor).getDistance(position);
405 }
double getDistance(const JVector3D &pos) const
Get distance to point.
Definition JVector3D.hh:270

◆ 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
parametersparameters
positionposition
floorfloor
Returns
gradient

Definition at line 416 of file JGeometry.hh.

419 {
420 if (floor == 0) {
421
422 return JMODEL::JString();
423
424 } else if (floor < this->size()) {
425
426 const JPosition3D pos = this->getPosition(parameters, floor);
427 const double height = (*this)[floor].getHeight();
428 const double h1 = height * (1.0 + parameters.vs);
429 const double z1 = mechanics.getHeight(h1);
430
431 const double tx = parameters.tx;
432 const double ty = parameters.ty;
433 const double tz = sqrt(1.0 - tx*tx - ty*ty);
434
435 const double dx = pos.getX() - position.getX();
436 const double dy = pos.getY() - position.getY();
437 const double dz = pos.getZ() - position.getZ();
438
439 const double D = sqrt(dx*dx + dy*dy + dz*dz);
440 const double vw = 1.0 - mechanics.a * mechanics.b / (1.0 - mechanics.a*h1);
441 const double vs = 1.0 + 0.5 * parameters.getLengthSquared() * vw;
442
443 return JMODEL::JString(z1 * dx / D - height * (tx / tz) * dz / D,
444 z1 * dy / D - height * (ty / tz) * dz / D,
445 h1*h1 * dx / D,
446 h1*h1 * dy / D,
447 height * vw * (tx * dx + ty * dy) / D + h1 * (dz / vs) / D);
448
449 } else {
450
451 THROW(JValueOutOfRange, "Invalid floor " << floor);
452 }
453 }
Data structure for position in three dimensions.
double getY() const
Get y position.
Definition JVector3D.hh:104
double getX() const
Get x position.
Definition JVector3D.hh:94

◆ getPosition() [4/5]

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

Get position.

Returns
position

Definition at line 130 of file JPosition3D.hh.

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

◆ getPosition() [5/5]

JPosition3D & JGEOMETRY3D::JPosition3D::getPosition ( )
inline

Get position.

Returns
position

Definition at line 141 of file JPosition3D.hh.

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

◆ setPosition()

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 }
JVector3D()
Default constructor.
Definition JVector3D.hh:41

◆ operator JAngle3D()

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 }

◆ operator JVersor3D()

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 }

◆ rotate() [1/5]

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 }

◆ rotate() [2/5]

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 }

◆ rotate() [3/5]

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 }

◆ rotate() [4/5]

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 }

◆ rotate() [5/5]

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 }

◆ rotate_back() [1/5]

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 }

◆ rotate_back() [2/5]

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 }

◆ rotate_back() [3/5]

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 }

◆ rotate_back() [4/5]

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 }

◆ rotate_back() [5/5]

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 }

◆ 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
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 }
JPosition3D & rotate(const JRotation3D &R)
Rotate.
JVector3D & sub(const JVector3D &vector)
Subtract vector.
Definition JVector3D.hh:158

◆ transform() [2/2]

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 }

◆ 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
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.
JVector3D & add(const JVector3D &vector)
Add vector.
Definition JVector3D.hh:142

◆ getDot() [1/4]

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 }

◆ getDot() [2/4]

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 }

◆ getDot() [3/4]

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 }

◆ getDot() [4/4]

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 }

◆ operator JVector2D()

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 }

◆ getX()

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 }

◆ getY()

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 }

◆ getZ()

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 }

◆ negate()

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 }

◆ add()

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 }

◆ sub()

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 }

◆ mul() [1/2]

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 }

◆ 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
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 }

◆ div()

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 }

◆ equals()

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 }

◆ getLengthSquared()

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 }

◆ getLength() [2/2]

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

◆ getDistanceSquared()

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 }

◆ getDistance() [2/2]

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

◆ 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
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 }

Friends And Related Symbol Documentation

◆ operator<<

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 463 of file JGeometry.hh.

464 {
465 using namespace std;
466
467 for (size_t i = 0; i != string.size(); ++i) {
468 if (string.hasFloor(i)) {
469 out << setw(2) << i << ' '
470 << FIXED(7,3) << string[i] << " | "
471 << string.getPosition(i) << ' '
472 << string.mechanics << endl;
473 }
474 }
475
476 return out;
477 }
Auxiliary data structure for floating point format specification.
Definition JManip.hh:448

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: