Shiokaze Framework
A research-oriented fluid solver for computer graphics
shared_macarray3< T > Class Template Reference

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

#include <shared_array3.h>

Public Member Functions

 shared_macarray3 (const shape3 &shape, vec3< T > initial_value=vec3< T >(), std::string core_name="")
 Borrow a shared MAC array. More...
 
 shared_macarray3 (const typename macarray3< T >::type3 &type, vec3< T > initial_value=vec3< T >())
 Borrow a shared array. More...
 
 shared_macarray3 (const macarray3< T > &array)
 Borrow a shared array and copy the input. More...
 
 ~shared_macarray3 ()
 Destructor for shared_macarray2.
 
const macarray3< T > & operator() () const
 Get the const reference to the internal borrowed array.
 
macarray3< T > & operator() ()
 Get the reference to the internal borrowed array.
 
macarray3< T > * operator-> ()
 Get the pointer to the internal borrowed array.
 
const macarray3< T > * operator-> () const
 Get the const pointer to the internal borrowed array.
 
macarray3< T > * get ()
 Get the pointer to the internal borrowed array.
 
const macarray3< T > * get () const
 Get the const pointer to the internal borrowed array.
 

Detailed Description

template<class T>
class shared_macarray3< T >

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

Constructor & Destructor Documentation

◆ shared_macarray3() [1/3]

template<class T >
shared_macarray3< T >::shared_macarray3 ( const shape3 shape,
vec3< T >  initial_value = vec3<T>(),
std::string  core_name = "" 
)
inline

Borrow a shared MAC array.

Parameters
[in]shapeShape of the grid.
[in]initial_valueInitial value.
[in]core_nameCore module name for the grid.

◆ shared_macarray3() [2/3]

template<class T >
shared_macarray3< T >::shared_macarray3 ( const typename macarray3< T >::type3 &  type,
vec3< T >  initial_value = vec3<T>() 
)
inline

Borrow a shared array.

Parameters
[in]shapeShape of the grid.
[in]initial_valueInitial value.

◆ shared_macarray3() [3/3]

template<class T >
shared_macarray3< T >::shared_macarray3 ( const macarray3< T > &  array)
inline

Borrow a shared array and copy the input.

Parameters
[in]arrayArray to copy from.

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