LifeV
Public Member Functions | Private Attributes
Sin Class Reference

Sin - Sinusoidal wave. More...

#include <ud_functions.hpp>

+ Collaboration diagram for Sin:

Public Member Functions

 Sin (const Real mean=0, const Real scale=10, const Real period=.01, const Real phase=0.)
 The constructor. More...
 
virtual ~Sin ()
 
Real operator() (const Real &time)
 Compute the sinus at the specified time. More...
 

Private Attributes

Real M_mean
 
Real M_scale
 
Real M_period
 
Real M_phase
 

Detailed Description

Sin - Sinusoidal wave.

Author
Lucia Mirabella

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

Constructor & Destructor Documentation

◆ Sin()

Sin ( const Real  mean = 0,
const Real  scale = 10,
const Real  period = .01,
const Real  phase = 0. 
)
inlineexplicit

The constructor.

Parameters
[in]meanthe time average of the sinus $ B $
[in]scalethe sinus amplitude $ A $
[in]periodthe sinus period $ T $
[in]phasethe sinus phase $ \phi $

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

+ Here is the caller graph for this function:

◆ ~Sin()

virtual ~Sin ( )
inlinevirtual

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

Member Function Documentation

◆ operator()()

Real operator() ( const Real &  time)
inline

Compute the sinus at the specified time.

Parameters
[in]timethe time
Returns
$ B + A sin( \frac{2 \pi t}{T} + \phi ) $

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

Field Documentation

◆ M_mean

Real M_mean
private

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

◆ M_scale

Real M_scale
private

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

◆ M_period

Real M_period
private

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

◆ M_phase

Real M_phase
private

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

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