FD::grid_dist_expression< dim, double, STAG_EXPRESSION > Class Template Reference

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

Detailed Description

template<unsigned int dim>
class FD::grid_dist_expression< dim, double, STAG_EXPRESSION >

Main class that encapsulate a double constant.

Parameters

prp	no meaning

Definition at line 1025 of file FD_expressions.hpp.

#include <FD_expressions.hpp>

Public Member Functions
	grid_dist_expression (const double &d)
	constructor from a constant expression
void	init () const
	This function must be called before value.
double	value (const grid_dist_key_dx< dim > &k, comb< dim > &c_where) const
	Evaluate the expression.

Private Attributes
double	d
	constant parameter

Constructor & Destructor Documentation

grid_dist_expression()

template<unsigned int dim>

FD::grid_dist_expression< dim, double, STAG_EXPRESSION >::grid_dist_expression ( const double &  d )

inline

constructor from a constant expression

Definition at line 1033 of file FD_expressions.hpp.

Member Function Documentation

init()

template<unsigned int dim>

void FD::grid_dist_expression< dim, double, STAG_EXPRESSION >::init ( ) const

inline

This function must be called before value.

it initialize the expression if needed

Definition at line 1042 of file FD_expressions.hpp.

value()

template<unsigned int dim>

double FD::grid_dist_expression< dim, double, STAG_EXPRESSION >::value ( const grid_dist_key_dx< dim > &  k, comb< dim > &  c_where  ) 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

Definition at line 1054 of file FD_expressions.hpp.

Field Documentation

d

template<unsigned int dim>

double FD::grid_dist_expression< dim, double, STAG_EXPRESSION >::d

private

constant parameter

Definition at line 1028 of file FD_expressions.hpp.

---

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

• openfpm_numerics/src/FiniteDifference/FD_expressions.hpp