FD::grid_dist_expression< dim, float, impl > Class Template Reference

Main class that encapsulate a float constant. More...

Detailed Description

template<unsigned int dim, unsigned int impl>
class FD::grid_dist_expression< dim, float, impl >

Main class that encapsulate a float constant.

Parameters

prp	no meaning

Definition at line 1066 of file FD_expressions.hpp.

#include <FD_expressions.hpp>

Public Types
typedef float	vtype
	type of object the structure return then evaluated

Public Member Functions
	grid_dist_expression (const float &d)
	constrictor from constant value
void	init () const
	This function must be called before value.
float	value (const grid_dist_key_dx< dim > &k) const
	Evaluate the expression.

Private Attributes
float	d
	constant value

Member Typedef Documentation

vtype

template<unsigned int dim, unsigned int impl>

typedef float FD::grid_dist_expression< dim, float, impl >::vtype

type of object the structure return then evaluated

Definition at line 1074 of file FD_expressions.hpp.

Constructor & Destructor Documentation

grid_dist_expression()

template<unsigned int dim, unsigned int impl>

FD::grid_dist_expression< dim, float, impl >::grid_dist_expression ( const float &  d )

inline

constrictor from constant value

Definition at line 1077 of file FD_expressions.hpp.

Member Function Documentation

init()

template<unsigned int dim, unsigned int impl>

void FD::grid_dist_expression< dim, float, impl >::init ( ) const

inline

This function must be called before value.

it initialize the expression if needed

Definition at line 1086 of file FD_expressions.hpp.

value()

template<unsigned int dim, unsigned int impl>

float FD::grid_dist_expression< dim, float, impl >::value ( const grid_dist_key_dx< dim > &  k ) const

inline

Evaluate the expression.

Parameters

k	ignored position in the grid

It just return the value set in the constructor

Returns

the constant value set in the constructor

Definition at line 1098 of file FD_expressions.hpp.

Field Documentation

d

template<unsigned int dim, unsigned int impl>

float FD::grid_dist_expression< dim, float, impl >::d

private

constant value

Definition at line 1069 of file FD_expressions.hpp.

---

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

• openfpm_numerics/src/FiniteDifference/FD_expressions.hpp