JACOUSTICS::JMechanics Struct Reference

Auxiliary data structure for parameters of mechanical model. More...

#include <JMechanics.hh>

Public Member Functions
	JMechanics ()
	Default constructor. More...
	JMechanics (const double a, const double b)
	Constructor. More...
double	getHeight (const double height) const
	Get effective height for given actual height. More...

Public Attributes
double	a
	0 <= a < (maximal height)⁻1; [m^-1] More...
double	b
	0 <= b; [m] More...

Friends
std::istream &	operator>> (std::istream &in, JMechanics &parameters)
	Read parameters from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JMechanics &parameters)
	Write parameters to output stream. More...

Detailed Description

Auxiliary data structure for parameters of mechanical model.

This data structure provides for the implementation of the effective height conform the mechanical model of string.

Definition at line 41 of file JMechanics.hh.

Constructor & Destructor Documentation

JMechanics() [1/2]

JACOUSTICS::JMechanics::JMechanics ( )

inline

Default constructor.

Definition at line 45 of file JMechanics.hh.

                 :
      a(0.0),
      b(0.0)
    {}

JMechanics() [2/2]

JACOUSTICS::JMechanics::JMechanics ( const double  a, const double  b  )

inline

Constructor.

Parameters

a	logarithmic term
b	linear term

Definition at line 57 of file JMechanics.hh.

                               :
      a(a),
      b(b)
    {}

Member Function Documentation

getHeight()

double JACOUSTICS::JMechanics::getHeight ( const double  height ) const

inline

Get effective height for given actual height.

Parameters

height

height

Returns

height

Definition at line 70 of file JMechanics.hh.

    {
      return height  +  this->b * log(1.0 - this->a * height);
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JMechanics &  parameters  )

friend

Read parameters from input stream.

Parameters

in	input stream
parameters	parameters

Returns

input stream

Definition at line 83 of file JMechanics.hh.

    {
      return in >> parameters.a >> parameters.b;
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JMechanics &  parameters  )

friend

Write parameters to output stream.

Parameters

out	output stream
parameters	parameters

Returns

output stream

Definition at line 96 of file JMechanics.hh.

    {
      return out << FIXED(7,5) << parameters.a << ' '
                 << FIXED(7,3) << parameters.b;
    }

Member Data Documentation

a

double JACOUSTICS::JMechanics::a

0 <= a < (maximal height)⁻1; [m^-1]

Definition at line 102 of file JMechanics.hh.

b

double JACOUSTICS::JMechanics::b

0 <= b; [m]

Definition at line 103 of file JMechanics.hh.

---

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

• JMechanics.hh