LifeV
Public Member Functions | Private Attributes
Cos_min_Sin Class Reference

Cos_min_Sin - A superimposition of a sinusoidal and a cosinusoidal waves, whose amplitude is damped by exponential terms. More...

#include <ud_functions.hpp>

+ Inheritance diagram for Cos_min_Sin:
+ Collaboration diagram for Cos_min_Sin:

Public Member Functions

 Cos_min_Sin (const Real coeff_exp_t_cos=0, const Real mean_cos=0, const Real amplitude_cos=10, const Real frequency_cos=8.*atan(1.), const Real phase_cos=0., const Real coeff_exp_t_sin=0, const Real mean_sin=0, const Real amplitude_sin=10, const Real frequency_sin=8.*atan(1.), const Real phase_sin=0.)
 The constructor. More...
 
virtual ~Cos_min_Sin ()
 
Real operator() (const Real &time)
 Compute the wave at the specified time. More...
 

Private Attributes

Real M_coeff_exp_t_cos
 
Real M_mean_cos
 
Real M_amplitude_cos
 
Real M_frequency_cos
 
Real M_phase_cos
 
Real M_coeff_exp_t_sin
 
Real M_mean_sin
 
Real M_amplitude_sin
 
Real M_frequency_sin
 
Real M_phase_sin
 

Getters

Real & coeff_exp_t_cos ()
 
Real & mean_cos ()
 
Real & amplitude_cos ()
 
Real & frequency_cos ()
 
Real & phase_cos ()
 
Real & coeff_exp_t_sin ()
 
Real & mean_sin ()
 
Real & amplitude_sin ()
 
Real & frequency_sin ()
 
Real & phase_sin ()
 

Detailed Description

Cos_min_Sin - A superimposition of a sinusoidal and a cosinusoidal waves, whose amplitude is damped by exponential terms.

Author
Lucia Mirabella

Definition at line 134 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

Constructor & Destructor Documentation

◆ Cos_min_Sin()

Cos_min_Sin ( const Real  coeff_exp_t_cos = 0,
const Real  mean_cos = 0,
const Real  amplitude_cos = 10,
const Real  frequency_cos = 8.*atan (1.),
const Real  phase_cos = 0.,
const Real  coeff_exp_t_sin = 0,
const Real  mean_sin = 0,
const Real  amplitude_sin = 10,
const Real  frequency_sin = 8.*atan (1.),
const Real  phase_sin = 0. 
)
inlineexplicit

The constructor.

Parameters
[in]coeff_exp_t_costhe coefficient multiplying time in the exponential damping the cosinus amplitude $ \lambda_c $
[in]mean_costhe time average of the cosinus $ B_c $
[in]amplitude_costhe cosinus amplitude $ A_c $
[in]frequency_costhe cosinus period $ T_c $
[in]phase_costhe cosinus phase $ \phi_c $
[in]coeff_exp_t_sinthe coefficient multiplying time in the exponential damping the sinus amplitude $ \lambda_s $
[in]mean_sinthe time average of the sinus $ B_s $
[in]amplitude_sinthe sinus amplitude $ A_s $
[in]frequency_sinthe sinus period $ T_s $
[in]phase_sinthe sinus phase $ \phi_s $

Definition at line 154 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

+ Here is the caller graph for this function:

◆ ~Cos_min_Sin()

virtual ~Cos_min_Sin ( )
inlinevirtual

Definition at line 172 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

Member Function Documentation

◆ operator()()

Real operator() ( const Real &  time)
inline

Compute the wave at the specified time.

Parameters
[in]timethe time
Returns
$ B_c + A_c cos( \frac{2 \pi t}{T_c} + \phi_c ) - ( B_s + A_s sin( \frac{2 \pi t}{T_s} + \phi_s ) ) $

Definition at line 181 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

+ Here is the caller graph for this function:

◆ coeff_exp_t_cos()

Real& coeff_exp_t_cos ( )
inline

Definition at line 194 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ mean_cos()

Real& mean_cos ( )
inline

Definition at line 198 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ amplitude_cos()

Real& amplitude_cos ( )
inline

Definition at line 202 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

+ Here is the caller graph for this function:

◆ frequency_cos()

Real& frequency_cos ( )
inline

Definition at line 206 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ phase_cos()

Real& phase_cos ( )
inline

Definition at line 210 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

+ Here is the caller graph for this function:

◆ coeff_exp_t_sin()

Real& coeff_exp_t_sin ( )
inline

Definition at line 214 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ mean_sin()

Real& mean_sin ( )
inline

Definition at line 218 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ amplitude_sin()

Real& amplitude_sin ( )
inline

Definition at line 222 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

+ Here is the caller graph for this function:

◆ frequency_sin()

Real& frequency_sin ( )
inline

Definition at line 226 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ phase_sin()

Real& phase_sin ( )
inline

Definition at line 230 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

+ Here is the caller graph for this function:

Field Documentation

◆ M_coeff_exp_t_cos

Real M_coeff_exp_t_cos
private

Definition at line 239 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_mean_cos

Real M_mean_cos
private

Definition at line 240 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_amplitude_cos

Real M_amplitude_cos
private

Definition at line 241 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_frequency_cos

Real M_frequency_cos
private

Definition at line 242 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_phase_cos

Real M_phase_cos
private

Definition at line 243 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_coeff_exp_t_sin

Real M_coeff_exp_t_sin
private

Definition at line 244 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_mean_sin

Real M_mean_sin
private

Definition at line 245 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_amplitude_sin

Real M_amplitude_sin
private

Definition at line 246 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_frequency_sin

Real M_frequency_sin
private

Definition at line 247 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

◆ M_phase_sin

Real M_phase_sin
private

Definition at line 248 of file multiscale/testsuite/onedmodel/ud_functions.hpp.

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