WARPXM v1.10.0
Loading...
Searching...
No Matches
WmICFunction_Ramp Class Reference

Base class for functions used in generating initial conditions. More...

#include <wmicfunction_ramp.h>

Inheritance diagram for WmICFunction_Ramp:
WmICFunction

Detailed Description

Base class for functions used in generating initial conditions.

Public Member Functions

 WmICFunction_Ramp ()
 Create new WmICFunction_Ramp.
 
 ~WmICFunction_Ramp ()
 Destroy WmICFunction_Ramp.
 
void setup (const WxCryptSet &wxc)
 Setup WmICFunction_Ramp object using supplied cryptset.
 
void applyFunction (const real *position, real *value) const
 Evaluate the function at a position and return the result through a pointer.
 
- Public Member Functions inherited from WmICFunction
 WmICFunction ()
 Create new WmICFunction.
 
virtual ~WmICFunction ()
 Destroy WmICFunction.
 
virtual void setup (const WxCryptSet &wxc)
 Setup WmICFunction object using supplied cryptset.
 
const std::string & getName () const
 Get name of this function.
 
int getNumArguments () const
 Get number of arguments returned by this icFunction.
 
template<typename T >
void apply (const real position[3], T *value) const
 Evaluate the function at a position and return the result through a pointer position and value must be double precision.
 

Additional Inherited Members

virtual void applyFunction (const real *position, real *value) const =0
 This is the currently apply function call - recasts to real.
 
- Protected Attributes inherited from WmICFunction
std::string _name
 
int _numArgs
 
real_rvalues
 

Constructor & Destructor Documentation

◆ WmICFunction_Ramp()

WmICFunction_Ramp::WmICFunction_Ramp ( )

Create new WmICFunction_Ramp.

◆ ~WmICFunction_Ramp()

WmICFunction_Ramp::~WmICFunction_Ramp ( )

Member Function Documentation

◆ applyFunction()

void WmICFunction_Ramp::applyFunction ( const real position,
real value 
) const
virtual

Evaluate the function at a position and return the result through a pointer.

Parameters
pPosition to evaluate function (must have at least 3 components)
vValue evaluated at position (must be allocated outside function)

Implements WmICFunction.

◆ setup()

void WmICFunction_Ramp::setup ( const WxCryptSet wxc)
virtual

Setup WmICFunction_Ramp object using supplied cryptset.

Parameters
wxcCryptset to use for setting

Reimplemented from WmICFunction.


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