UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | List of all members
sim::fdm::Source Class Reference

#include <sim_fdm_source.hpp>

Public Member Functions

 Source (const Point2D &initial_coords, const CoordT &vel, const Impulse &impulse, const int coords_mask=X_COORD|Z_COORD)
 
 Source (const Source &other)
 
Sourceoperator= (const Source &other)
 
const Point2DinitialCoords () const
 
void setInitialCoords (const Point2D &initial_coords)
 
const CoordT & vel () const
 
void setVel (const CoordT &vel)
 
const Impulseimpulse () const
 
void setImpulse (const Impulse &impulse)
 
int coordsMask () const
 
void setCoordsMask (const int coords_mask)
 
bool operator() (const TimeT &initial_time, Snapshot &snapshot) const
 

Protected Attributes

Point2D m_initial_coords
 
CoordT m_vel
 
Impulsemp_impulse
 
int m_coords_mask
 

Detailed Description

Source function. Provides momental snapshot (x,z) of initial amplitudes.

Constructor & Destructor Documentation

sim::fdm::Source::Source ( const Point2D initial_coords,
const CoordT &  vel,
const Impulse impulse,
const int  coords_mask = X_COORD|Z_COORD 
)
Construct source.
Parameters
initial_coordsInitial coordinates of source impulse (m).
velVelocity near initial coords (m/s).
impulseImpulse of the source.
coords_maskMask of coordinates of the source projections.

Member Function Documentation

bool sim::fdm::Source::operator() ( const TimeT &  initial_time,
Snapshot snapshot 
) const
Updates provided snapshot with source signal.  
Parameters
snapshotxz-snapshot to be updated with amplitudes of the source.
Returns
false on error.

Member Data Documentation

int sim::fdm::Source::m_coords_mask
protected

Mask of coordinates of the source projections.

Point2D sim::fdm::Source::m_initial_coords
protected

Initial coordinates of source impulse (m).

CoordT sim::fdm::Source::m_vel
protected

Velocity near initial coords (m/s).

Impulse* sim::fdm::Source::mp_impulse
protected

Impulse of the source.


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