Nodes Namespace Reference

Classes
struct	dataNode
struct	Node

Enumerations
enum	step { CURRENT = 0 , NEXT = 1 }
enum	index { IDX_UNDEF = -1 , IDX_X = 0 , IDX_Y = 1 , IDX_Z = 2 }

Functions
double	sq (const double x)
template<step K>
Eigen::Vector3d	get_u (Node const &n)
template<step K>
Eigen::Vector3d	get_v (Node const &n)
template<step K>
double	get_phi (Node const &n)
template<step K>
double	get_phiv (Node const &n)
double	get_u_comp (Node const &n, index idx)
double	get_v_comp (Node const &n, index idx)
void	set_phi (Node &n, double val)
void	set_phiv (Node &n, double val)

Variables
const int	DIM = 3
const int	NB_DATANODE = 2

Detailed Description

to grab altogether some dedicated functions and data of the nodes

Enumeration Type Documentation

index

enum Nodes::index

convenient enum to specify what coordinate in calculations

step

enum Nodes::step

convenient enum to avoid direct index manipulation in the array of struct dataNode

Function Documentation

get_phi()

template<step K>

double Nodes::get_phi

(

Node const &

n

)

getter for phis

Parameters

[in]

n

get_phiv()

template<step K>

double Nodes::get_phiv

(

Node const &

n

)

getter for phivs

Parameters

[in]

n

get_u()

template<step K>

Eigen::Vector3d Nodes::get_u

(

Node const &

n

)

getter for magnetizations

Parameters

[in]

n

get_u_comp()

double Nodes::get_u_comp ( Node const &  n, index  idx  )

inline

getter for u component

Parameters

[in]	n
[in]	idx

get_v()

template<step K>

Eigen::Vector3d Nodes::get_v

(

Node const &

n

)

getter for speed magnetizations

Parameters

[in]

n

get_v_comp()

double Nodes::get_v_comp ( Node const &  n, index  idx  )

inline

getter for v component

Parameters

[in]	n
[in]	idx

set_phi()

void Nodes::set_phi ( Node &  n, double  val  )

inline

setter for phi

set_phiv()

void Nodes::set_phiv ( Node &  n, double  val  )

inline

setter for phi_v

sq()

double Nodes::sq ( const double  x )

inline

Returns

\( x^2 \)

Variable Documentation

DIM

const int Nodes::DIM = 3

space dimension

NB_DATANODE

const int Nodes::NB_DATANODE = 2

size of the array of dataNode