shared_macarray2< T > Class Template Reference

Storage class that enables sharing pre-allocated arrays for MAC grid. More...

#include <shared_array2.h>

Public Member Functions
	shared_macarray2 (const shape2 &shape, vec2< T > initial_value=vec2< T >(), std::string core_name="")
	Borrow a shared MAC array. More...
	shared_macarray2 (const typename macarray2< T >::type2 &type, vec2< T > initial_value=vec2< T >())
	Borrow a shared array. More...
	shared_macarray2 (const macarray2< T > &array)
	Borrow a shared array and copy the input. More...
	~shared_macarray2 ()
	Destructor for shared_macarray2.
const macarray2< T > &	operator() () const
	Get the const reference to the internal borrowed array.
macarray2< T > &	operator() ()
	Get the reference to the internal borrowed array.
macarray2< T > *	operator-> ()
	Get the pointer to the internal borrowed array.
const macarray2< T > *	operator-> () const
	Get the const pointer to the internal borrowed array.
macarray2< T > *	get ()
	Get the pointer to the internal borrowed array.
const macarray2< T > *	get () const
	Get the const pointer to the internal borrowed array.

Detailed Description

template<class T>
class shared_macarray2< T >

Storage class that enables sharing pre-allocated arrays for MAC grid.

Constructor & Destructor Documentation

shared_macarray2() [1/3]

template<class T >

shared_macarray2< T >::shared_macarray2 ( const shape2 &  shape, vec2< T >  initial_value = vec2<T>(), std::string  core_name = ""  )

inline

Borrow a shared MAC array.

Parameters

[in]	shape	Shape of the grid.
[in]	initial_value	Initial value.
[in]	core_name	Core module name for the grid.

shared_macarray2() [2/3]

template<class T >

shared_macarray2< T >::shared_macarray2 ( const typename macarray2< T >::type2 &  type, vec2< T >  initial_value = vec2<T>()  )

inline

Borrow a shared array.

Parameters

[in]	shape	Shape of the grid.
[in]	initial_value	Initial value.

shared_macarray2() [3/3]

template<class T >

shared_macarray2< T >::shared_macarray2 ( const macarray2< T > &  array )

inline

Borrow a shared array and copy the input.

Parameters

[in]

array

Array to copy from.

---

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

• include/shiokaze/array/shared_array2.h