LbmLib::Field< T > Struct Template Reference

The Field struct Storage of values in x and y direction. More...

#include <Field.hpp>

Public Member Functions
	Field ()
	Constructor.
	Field (T xC, T yC)
	Construtor. More...
Field< T > &	operator+= (const Field< T > &rhs)
	The += operator. More...
Field< T > &	operator-= (const Field< T > &rhs)
	The -= operator. More...
Field< T > &	operator*= (const Field< T > &rhs)
	The *= operator. More...
Field< T > &	operator*= (double rhs)
	The *= operator. More...
Field< T > &	operator/= (double rhs)
	The /= operator. More...

Public Attributes
T	x
	x the value in x direction
T	y
	y the value in y direction

Detailed Description

template<typename T>
struct LbmLib::Field< T >

The Field struct Storage of values in x and y direction.

Definition at line 30 of file Field.hpp.

Constructor & Destructor Documentation

template<typename T>

LbmLib::Field< T >::Field ( T  xC, T  yC  )

inlineexplicit

Construtor.

Parameters

xC	the parameter for the x value
yC	the parameter for the y value

Definition at line 42 of file Field.hpp.

Member Function Documentation

template<typename T>

Field<T>& LbmLib::Field< T >::operator*= ( const Field< T > &  rhs )

inline

The *= operator.

Parameters

rhs	the righthand side field

Returns

this field * rhs field

Definition at line 86 of file Field.hpp.

template<typename T>

Field<T>& LbmLib::Field< T >::operator*= ( double  rhs )

inline

The *= operator.

Parameters

rhs	a double value by which this field is multiplied

Returns

this field * rhs

Definition at line 98 of file Field.hpp.

template<typename T>

Field<T>& LbmLib::Field< T >::operator+= ( const Field< T > &  rhs )

inline

The += operator.

Parameters

rhs	the righthand side field

Returns

this field + rhs field

Definition at line 62 of file Field.hpp.

template<typename T>

Field<T>& LbmLib::Field< T >::operator-= ( const Field< T > &  rhs )

inline

The -= operator.

Parameters

rhs	the righthand side field

Returns

this field - rhs field

Definition at line 74 of file Field.hpp.

template<typename T>

Field<T>& LbmLib::Field< T >::operator/= ( double  rhs )

inline

The /= operator.

Parameters

rhs	the righthand side field

Returns

this field / rhs field

Definition at line 110 of file Field.hpp.

---

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

• /home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/include/Field.hpp