rhs_CNLS Class Reference

The class defining the CNLS equations. More...

#include <rhs_CNLS.h>

Inheritance diagram for rhs_CNLS:

Collaboration diagram for rhs_CNLS:

Public Member Functions
virtual std::vector< std::string >	dependencies () const
virtual std::string	type () const
virtual void	postprocess (input &dat)
	~rhs_CNLS ()
virtual int	dxdt (ptr_passer x, ptr_passer dx, double t)
Public Member Functions inherited from rhs_type< comp >
virtual const std::type_info &	vtype () const
	returns the type of the current variable
virtual void	initial_condition (ptr_passer in, size_t len)
	Generic initial condition, call default constructor for each element/.
Public Member Functions inherited from rhs
	rhs ()
	Creates the base rhs class with a dimension=dimen.
void	initial_condition (ptr_passer x)
	Wrapper for intial_condition that assumes the length is equal to dimension.
virtual	~rhs ()
Public Member Functions inherited from item_dim
size_t	get_dimension () const
Public Member Functions inherited from item
	item ()
virtual	~item ()
virtual void	print () const
	Standard print function.
virtual void	update ()
void	setname (const std::string n)
void	set_write_name (std::string wname)
const std::string &	name () const
const std::string &	write_name () const
Public Member Functions inherited from vartype
bool	compare (const vartype *in) const
bool	compare (const vartype &in) const
bool	compare (const std::type_info &tinf)
template<typename T >
bool	compare () const
template<typename T >
bool	compare (const T &in) const
std::string	vname () const
virtual const std::type_info &	vtype_internal () const
bool	compare_internal (const vartype *in) const
bool	compare_internal (const vartype &in) const
bool	compare_internal (const std::type_info &tinf)
template<typename T >
bool	compare_internal () const
template<typename T >
bool	compare_internal (const T &in) const
std::string	vname_internal () const
virtual	~vartype ()

Public Attributes
double *restr	k

Private Attributes
comp *restr	u1
comp *restr *restr	u2
comp *restr *restr *restr	uf1
comp *restr *restr *restr *restr	uf2
comp *restr *restr *restr *restr *restr	comp_in
comp *restr *restr *restr *restr *restr *restr	comp_out
comp *restr *restr *restr *restr *restr *restr *restr	comp_out_r
comp *restr *restr *restr *restr *restr *restr *restr *restr	comp_in_r
double *restr	sq1
double *restr *restr	sq2
double *restr *restr *restr	ksq
double	g0
double	e0
double	dt
double	LENGTH_T
size_t	NUM_TIME_STEPS

Additional Inherited Members
Static Public Member Functions inherited from item
static std::shared_ptr< item >	create (std::string name, engineimp *rval)
Protected Member Functions inherited from item_dim
void	print_upstream ()
virtual void	_do_mem_update (size_t dim_old)
void	add_as_parent (item_dim *p)
void	add_as_parent (std::shared_ptr< item_dim > p)
void	update_dim (size_t dim_new)
Protected Attributes inherited from item_dim
mempool	memp
std::set< item_dim * >	children
item_dim *	parent
size_t	dimension

Detailed Description

The class defining the CNLS equations.

This class provides an implementation of the coupled nonlinear schrodinger equations SHOULD ADD ACTUAL EQUATIONS

Definition at line 25 of file rhs_CNLS.h.

Constructor & Destructor Documentation

rhs_CNLS::~rhs_CNLS

(

)

Destructor for rhs_CNLS

Definition at line 26 of file rhs_CNLS.cpp.

Member Function Documentation

std::vector< std::string > rhs_CNLS::dependencies ( ) const

virtual

Implements item_dim.

Definition at line 85 of file rhs_CNLS.cpp.

Here is the call graph for this function:

int rhs_CNLS::dxdt ( ptr_passer  x, ptr_passer  dx, double  t  )

virtual

Implements rhs.

Definition at line 28 of file rhs_CNLS.cpp.

Here is the call graph for this function:

void rhs_CNLS::postprocess ( input &  dat )

virtual

Initializes the rhs_CNLS class

Reimplemented from item_dim.

Definition at line 96 of file rhs_CNLS.cpp.

Here is the call graph for this function:

std::string rhs_CNLS::type ( ) const

virtual

Implements item.

Definition at line 90 of file rhs_CNLS.cpp.

Member Data Documentation

comp* restr * restr * restr * restr * restr rhs_CNLS::comp_in

private

Definition at line 27 of file rhs_CNLS.h.

comp* restr * restr * restr * restr * restr * restr * restr * restr rhs_CNLS::comp_in_r

private

Definition at line 27 of file rhs_CNLS.h.

comp* restr * restr * restr * restr * restr * restr rhs_CNLS::comp_out

private

Definition at line 27 of file rhs_CNLS.h.

comp* restr * restr * restr * restr * restr * restr * restr rhs_CNLS::comp_out_r

private

Definition at line 27 of file rhs_CNLS.h.

double rhs_CNLS::dt

private

Definition at line 32 of file rhs_CNLS.h.

double rhs_CNLS::e0

private

Definition at line 31 of file rhs_CNLS.h.

double rhs_CNLS::g0

private

Definition at line 30 of file rhs_CNLS.h.

double* restr rhs_CNLS::k

Definition at line 36 of file rhs_CNLS.h.

double* restr * restr * restr rhs_CNLS::ksq

private

Definition at line 29 of file rhs_CNLS.h.

double rhs_CNLS::LENGTH_T

private

Definition at line 33 of file rhs_CNLS.h.

size_t rhs_CNLS::NUM_TIME_STEPS

private

Definition at line 34 of file rhs_CNLS.h.

double* restr rhs_CNLS::sq1

private

Definition at line 29 of file rhs_CNLS.h.

double* restr * restr rhs_CNLS::sq2

private

Definition at line 29 of file rhs_CNLS.h.

comp* restr rhs_CNLS::u1

private

Definition at line 27 of file rhs_CNLS.h.

comp* restr * restr rhs_CNLS::u2

private

Definition at line 27 of file rhs_CNLS.h.

comp* restr * restr * restr rhs_CNLS::uf1

private

Definition at line 27 of file rhs_CNLS.h.

comp* restr * restr * restr * restr rhs_CNLS::uf2

private

Definition at line 27 of file rhs_CNLS.h.

---

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

• rhs/rhs_CNLS.h
• rhs/rhs_CNLS.cpp