Main class that encapsulate a grid properties operand to be used for expressions construction. More...

Detailed Description

template<unsigned int dim>
class FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >

Main class that encapsulate a grid properties operand to be used for expressions construction.

Template Parameters

prp	property involved
grid	involved

Definition at line 2073 of file FD_expressions.hpp.

#include <FD_expressions.hpp>

Public Types
typedef grid_dist_key_dx< dim, grid_key_dx< dim > >	index_type

typedef grid_dist_expression_iterator_to_make_algebra_work< dim >	gtype
	The type of the internal grid.

Public Member Functions
gdb_ext_plus_g_info< dim >	size () const

template<typename grid >
	grid_dist_expression (grid &g)
	constructor for an external grid

template<typename grid >
void	resize (grid &g)

grid_dist_expression_iterator_to_make_algebra_work< dim >	getVector () const

grid_dist_expression_iterator_to_make_algebra_work< dim >	getGrid ()
	Return the grid on which is acting.

const grid_dist_expression_iterator_to_make_algebra_work< dim >	getGrid () const
	Return the grid on which is acting.

void	init () const
	This function must be called before value.

double	value (const grid_dist_key_dx< dim > &k, const comb< dim > &c_where=comb< dim >()) const
	Evaluate the expression.

double &	value_ref (const grid_dist_key_dx< dim > &k, const comb< dim > &c_where=comb< dim >())
	Evaluate the expression.

template<unsigned int prp2, typename grid >
const grid &	operator= (const grid_dist_expression< prp2, grid, NORM_EXPRESSION > &g_exp)
	Fill the grid property with the evaluated expression.

template<typename exp1 , typename exp2 , typename op >
auto	operator= (const grid_dist_expression_op< exp1, exp2, op > &g_exp) -> decltype(g_exp.getGrid())
	Fill the grid property with the evaluated expression.

double	get (grid_dist_key_dx< dim > &key)

int	isConstant ()

Static Public Attributes
static constexpr unsigned int	dims = dim

static const unsigned int	prop = 0
	Property id of the point.

Private Types
typedef double	type_proc

Private Member Functions
template<typename super_general >
void	operator_equal (super_general &g_exp)

Private Attributes
grid_patches< grid_cpu< dim, aggregate< double > > >	data
	The grid.

openfpm::vector< GBoxes< dim > >	gdb_ext

grid_sm< dim, void >	ginfo_v
	Grid informations object without type.

Member Typedef Documentation

◆ gtype

template<unsigned int dim>

typedef grid_dist_expression_iterator_to_make_algebra_work<dim> FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::gtype

The type of the internal grid.

Definition at line 2114 of file FD_expressions.hpp.

◆ index_type

template<unsigned int dim>

typedef grid_dist_key_dx<dim,grid_key_dx<dim> > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::index_type

Definition at line 2111 of file FD_expressions.hpp.

◆ type_proc

template<unsigned int dim>

typedef double FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::type_proc

private

Definition at line 2083 of file FD_expressions.hpp.

Constructor & Destructor Documentation

◆ grid_dist_expression() [1/2]

template<unsigned int dim>

FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::grid_dist_expression ( )

inline

Definition at line 2119 of file FD_expressions.hpp.

◆ grid_dist_expression() [2/2]

template<unsigned int dim>

template<typename grid >

FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::grid_dist_expression ( grid & g )

inline

constructor for an external grid

Definition at line 2129 of file FD_expressions.hpp.

Member Function Documentation

◆ get()

template<unsigned int dim>

double FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::get ( grid_dist_key_dx< dim > & key )

inline

Definition at line 2253 of file FD_expressions.hpp.

◆ getGrid() [1/2]

template<unsigned int dim>

grid_dist_expression_iterator_to_make_algebra_work< dim > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::getGrid ( )

inline

Return the grid on which is acting.

It return the grid used in getVExpr, to get this object

Returns: the grid

Definition at line 2162 of file FD_expressions.hpp.

◆ getGrid() [2/2]

template<unsigned int dim>

const grid_dist_expression_iterator_to_make_algebra_work< dim > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::getGrid ( ) const

inline

Return the grid on which is acting.

It return the grid used in getVExpr, to get this object

Returns: the grid

Definition at line 2174 of file FD_expressions.hpp.

◆ getVector()

template<unsigned int dim>

grid_dist_expression_iterator_to_make_algebra_work< dim > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::getVector ( ) const

inline

Definition at line 2150 of file FD_expressions.hpp.

◆ init()

template<unsigned int dim>

void FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::init ( ) const

inline

This function must be called before value.

it initialize the expression if needed

Definition at line 2184 of file FD_expressions.hpp.

◆ isConstant()

template<unsigned int dim>

int FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::isConstant ( )

inline

Definition at line 2260 of file FD_expressions.hpp.

◆ operator=() [1/2]

template<unsigned int dim>

template<unsigned int prp2, typename grid >

const grid & FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::operator= ( const grid_dist_expression< prp2, grid, NORM_EXPRESSION > & g_exp )

inline

Fill the grid property with the evaluated expression.

Parameters

v_exp expression to evaluate

Returns: itself

Definition at line 2231 of file FD_expressions.hpp.

◆ operator=() [2/2]

template<unsigned int dim>

template<typename exp1 , typename exp2 , typename op >

auto FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::operator= ( const grid_dist_expression_op< exp1, exp2, op > & g_exp ) -> decltype(g_exp.getGrid())

inline

Fill the grid property with the evaluated expression.

Parameters

v_exp expression to evaluate

Returns: itself

Definition at line 2245 of file FD_expressions.hpp.

◆ operator_equal()

template<unsigned int dim>

template<typename super_general >

void FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::operator_equal ( super_general & g_exp )

inlineprivate

Definition at line 2086 of file FD_expressions.hpp.

◆ resize()

template<unsigned int dim>

template<typename grid >

void FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::resize ( grid & g )

inline

Definition at line 2135 of file FD_expressions.hpp.

◆ size()

template<unsigned int dim>

gdb_ext_plus_g_info< dim > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::size ( ) const

inline

Definition at line 2122 of file FD_expressions.hpp.

◆ value()

template<unsigned int dim>

double FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::value	(	const grid_dist_key_dx< dim > &	k,
		const comb< dim > &	c_where = `comb<dim>()`
	)		const

inline

Evaluate the expression.

Parameters

k	where to evaluate the expression

Returns: the result of the expression

Definition at line 2194 of file FD_expressions.hpp.

◆ value_ref()

template<unsigned int dim>

double & FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::value_ref	(	const grid_dist_key_dx< dim > &	k,
		const comb< dim > &	c_where = `comb<dim>()`
	)

inline

Evaluate the expression.

Parameters

k	where to evaluate the expression

Returns: the result of the expression

Evaluate the expression

Parameters

k	where to evaluate the expression

Returns: the result of the expression

Definition at line 2219 of file FD_expressions.hpp.

Field Documentation

◆ data

template<unsigned int dim>

grid_patches<grid_cpu<dim,aggregate<double> > > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::data

mutableprivate

The grid.

Definition at line 2076 of file FD_expressions.hpp.

◆ dims

template<unsigned int dim>

constexpr unsigned int FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::dims = dim

staticconstexpr

Definition at line 2109 of file FD_expressions.hpp.

◆ gdb_ext

template<unsigned int dim>

openfpm::vector<GBoxes<dim> > FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::gdb_ext

mutableprivate

Definition at line 2078 of file FD_expressions.hpp.

◆ ginfo_v

template<unsigned int dim>

grid_sm<dim,void> FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::ginfo_v

mutableprivate

Grid informations object without type.

Definition at line 2081 of file FD_expressions.hpp.

◆ prop

template<unsigned int dim>

const unsigned int FD::grid_dist_expression< 0, grid_patches< grid_cpu< dim, aggregate< double > > >, NORM_EXPRESSION >::prop = 0

static

Property id of the point.

Definition at line 2117 of file FD_expressions.hpp.

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

openfpm_numerics/src/FiniteDifference/FD_expressions.hpp

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ gtype

◆ index_type

◆ type_proc

Constructor & Destructor Documentation

◆ grid_dist_expression() [1/2]

◆ grid_dist_expression() [2/2]

Member Function Documentation

◆ get()

◆ getGrid() [1/2]

◆ getGrid() [2/2]

◆ getVector()

◆ init()

◆ isConstant()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator_equal()

◆ resize()

◆ size()

◆ value()

◆ value_ref()

Field Documentation

◆ data

◆ dims

◆ gdb_ext

◆ ginfo_v

◆ prop