svMultiPhysics
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
stimType Class Reference

External stimulus type. More...

#include <CepMod.h>

Classes

class  SpatialBounds
 Spatial bounds for a CEP stimulus region. More...
 

Public Member Functions

double operator() (const double time, const Vector< double > &x) const
 Return the applied stimulus value at a point and time.
 
void read_parameters (const StimulusParameters &params, const int nsd, const double default_cycle_length)
 Set stimulus parameters from parsed XML parameters.
 
void distribute (const CmMod &cm_mod, const cmType &cm)
 Broadcast stimulus parameters to all ranks.
 

Detailed Description

External stimulus type.

Member Function Documentation

◆ distribute()

void stimType::distribute ( const CmMod &  cm_mod,
const cmType &  cm 
)

Broadcast stimulus parameters to all ranks.

◆ operator()()

double stimType::operator() ( const double  time,
const Vector< double > &  x 
) const

Return the applied stimulus value at a point and time.

◆ read_parameters()

void stimType::read_parameters ( const StimulusParameters &  params,
const int  nsd,
const double  default_cycle_length 
)

Set stimulus parameters from parsed XML parameters.


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