Shiokaze Framework
A research-oriented fluid solver for computer graphics
Public Member Functions | List of all members
shared_array3< T > Class Template Reference

Storage class that enables sharing pre-allocated arrays. More...

#include <shared_array3.h>

Public Member Functions

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

Detailed Description

template<class T>
class shared_array3< T >

Storage class that enables sharing pre-allocated arrays.

Constructor & Destructor Documentation

◆ shared_array3() [1/3]

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

Borrow a shared array.

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

◆ shared_array3() [2/3]

template<class T >
shared_array3< T >::shared_array3 ( const typename array3< T >::type3 &  type,
T  initial_value = T() 
)
inline

Borrow a shared array.

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

◆ shared_array3() [3/3]

template<class T >
shared_array3< T >::shared_array3 ( const array3< 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: