wxm::functions::plasma_switch_fields Class Reference

Initialize the EM fields for the simplified 2D plasma switch problem with a normalized Poynting vector [1,0,0]. More...

#include <plasma_switch_fields.h>

Inheritance diagram for wxm::functions::plasma_switch_fields:

Detailed Description

Initialize the EM fields for the simplified 2D plasma switch problem with a normalized Poynting vector [1,0,0].

Parameters

center	x coordinate of max B field
omega_c_norm
omega_p_norm
c_0_norm
width	horizontal width of the B field pulse
width_frac	where on the gaussian to measure the width; 0.5 means FWHM
min_B	minimum B field
max_B	maximum B field

Public Member Functions
	plasma_switch_fields ()
	~plasma_switch_fields () override=default
void	setup (const WxCryptSet &wxc) override
	Setup WmICFunction object using supplied cryptset.
void	applyFunction (const real *position, real *value) const override
	This is the currently apply function call - recasts to real.
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

plasma_switch_fields()

wxm::functions::plasma_switch_fields::plasma_switch_fields

(

)

~plasma_switch_fields()

wxm::functions::plasma_switch_fields::~plasma_switch_fields ( )

overridedefault

Member Function Documentation

applyFunction()

void wxm::functions::plasma_switch_fields::applyFunction ( const real *  position, real *  value  ) const

overridevirtual

This is the currently apply function call - recasts to real.

Parameters

p	Position to evaluate function
v	Value evaluated at position (must be allocated outside function)

Implements WmICFunction.

setup()

void wxm::functions::plasma_switch_fields::setup ( const WxCryptSet &  wxc )

overridevirtual

Setup WmICFunction object using supplied cryptset.

Parameters

wxc	Cryptset to use for setting

Reimplemented from WmICFunction.

---

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

• src/initialConditions/plasma_switch_fields.h