Abstract base class for N-D cartesian grid structure. More...

#include <Core/Grid/Grid.hpp>

Inheritance diagram for CubbyFlow::Grid< N >:

Public Member Functions
	Grid ()=default
	Constructs an empty grid. More...

	~Grid () override=default
	Default virtual destructor. More...

	Grid (const Grid &other)
	Copy constructor. More...

	Grid (Grid &&other) noexcept
	Move constructor. More...

Grid &	operator= (const Grid &other)
	Copy assignment operator. More...

Grid &	operator= (Grid &&other) noexcept
	Move assignment operator. More...

virtual std::string	TypeName () const =0
	Returns the type name of derived grid. More...

const Vector< size_t, N > &	Resolution () const
	Returns the grid resolution. More...

const Vector< double, N > &	Origin () const
	Returns the grid origin. More...

const Vector< double, N > &	GridSpacing () const
	Returns the grid spacing. More...

const BoundingBox< double, N > &	GetBoundingBox () const
	Returns the bounding box of the grid. More...

GridDataPositionFunc< N >	CellCenterPosition () const
	Returns the function that maps grid index to the cell-center position. More...

void	ForEachCellIndex (const std::function< void(const Vector< size_t, N > &)> &func) const
	Invokes the given function `func` for each grid cell. More...

template<size_t M = N>
std::enable_if_t< M==2, void >	ForEachCellIndex (const std::function< void(size_t, size_t)> &func) const

template<size_t M = N>
std::enable_if_t< M==3, void >	ForEachCellIndex (const std::function< void(size_t, size_t, size_t)> &func) const

void	ParallelForEachCellIndex (const std::function< void(const Vector< size_t, N > &)> &func) const
	Invokes the given function `func` for each grid cell in parallel. More...

template<size_t M = N>
std::enable_if_t< M==2, void >	ParallelForEachCellIndex (const std::function< void(size_t, size_t)> &func) const

template<size_t M = N>
std::enable_if_t< M==3, void >	ParallelForEachCellIndex (const std::function< void(size_t, size_t, size_t)> &func) const

bool	HasSameShape (const Grid &other) const
	Returns true if resolution, grid-spacing and origin are same. More...

virtual void	Swap (Grid *other)=0
	Swaps the data with other grid. More...

Public Member Functions inherited from CubbyFlow::Serializable
	Serializable ()=default
	Default constructor. More...

	Serializable (const Serializable &)=default
	Default copy constructor. More...

	Serializable (Serializable &&) noexcept=default
	Default move constructor. More...

virtual	~Serializable ()=default
	Default virtual destructor. More...

Serializable &	operator= (const Serializable &)=default
	Default copy assignment operator. More...

Serializable &	operator= (Serializable &&) noexcept=default
	Default move assignment operator. More...

virtual void	Serialize (std::vector< uint8_t > *buffer) const =0
	Serializes this instance into the flat buffer. More...

virtual void	Deserialize (const std::vector< uint8_t > &buffer)=0
	Deserializes this instance from the flat buffer. More...

Protected Member Functions
void	SetSizeParameters (const Vector< size_t, N > &resolution, const Vector< double, N > &gridSpacing, const Vector< double, N > &origin)

void	SwapGrid (Grid *other)
	Swaps the size parameters with given grid `other`. More...

void	SetGrid (const Grid &other)
	Sets the size parameters with given grid `other`. More...

virtual void	GetData (Array1< double > &data) const =0
	Fetches the data into a continuous linear array. More...

virtual void	SetData (const ConstArrayView1< double > &data)=0
	Sets the data from a continuous linear array. More...

Detailed Description

template<size_t N>
class CubbyFlow::Grid< N >

Abstract base class for N-D cartesian grid structure.

This class represents N-D cartesian grid structure. This class is an abstract base class and does not store any data. The class only stores the shape of the grid. The grid structure is axis-aligned and can have different grid spacing per axis.

Constructor & Destructor Documentation

◆ Grid() [1/3]

template<size_t N>

CubbyFlow::Grid< N >::Grid ( )

default

Constructs an empty grid.

◆ ~Grid()

template<size_t N>

CubbyFlow::Grid< N >::~Grid ( )

overridedefault

Default virtual destructor.

◆ Grid() [2/3]

template<size_t N>

CubbyFlow::Grid< N >::Grid ( const Grid< N > & other )

Copy constructor.

◆ Grid() [3/3]

template<size_t N>

CubbyFlow::Grid< N >::Grid ( Grid< N > && other )

noexcept

Move constructor.

Member Function Documentation

◆ CellCenterPosition()

template<size_t N>

GridDataPositionFunc<N> CubbyFlow::Grid< N >::CellCenterPosition ( ) const

Returns the function that maps grid index to the cell-center position.

◆ ForEachCellIndex() [1/3]

template<size_t N>

void CubbyFlow::Grid< N >::ForEachCellIndex ( const std::function< void(const Vector< size_t, N > &)> & func ) const

Invokes the given function func for each grid cell.

This function invokes the given function object func for each grid cell in serial manner. The input parameters are i and j indices of a grid cell. The order of execution is i-first, j-last.

◆ ForEachCellIndex() [2/3]

template<size_t N>

template<size_t M = N>

std::enable_if_t<M == 2, void> CubbyFlow::Grid< N >::ForEachCellIndex ( const std::function< void(size_t, size_t)> & func ) const

inline

◆ ForEachCellIndex() [3/3]

template<size_t N>

template<size_t M = N>

std::enable_if_t<M == 3, void> CubbyFlow::Grid< N >::ForEachCellIndex ( const std::function< void(size_t, size_t, size_t)> & func ) const

inline

◆ GetBoundingBox()

template<size_t N>

const BoundingBox<double, N>& CubbyFlow::Grid< N >::GetBoundingBox ( ) const

Returns the bounding box of the grid.

◆ GetData()

template<size_t N>

virtual void CubbyFlow::Grid< N >::GetData ( Array1< double > & data ) const

protectedpure virtual

Fetches the data into a continuous linear array.

Implemented in CubbyFlow::FaceCenteredGrid< N >, CubbyFlow::ScalarGrid< N >, and CubbyFlow::CollocatedVectorGrid< N >.

◆ GridSpacing()

template<size_t N>

const Vector<double, N>& CubbyFlow::Grid< N >::GridSpacing ( ) const

Returns the grid spacing.

◆ HasSameShape()

template<size_t N>

bool CubbyFlow::Grid< N >::HasSameShape ( const Grid< N > & other ) const

Returns true if resolution, grid-spacing and origin are same.

◆ operator=() [1/2]

template<size_t N>

Grid& CubbyFlow::Grid< N >::operator= ( const Grid< N > & other )

Copy assignment operator.

◆ operator=() [2/2]

template<size_t N>

Grid& CubbyFlow::Grid< N >::operator= ( Grid< N > && other )

noexcept

Move assignment operator.

◆ Origin()

template<size_t N>

const Vector<double, N>& CubbyFlow::Grid< N >::Origin ( ) const

Returns the grid origin.

◆ ParallelForEachCellIndex() [1/3]

template<size_t N>

void CubbyFlow::Grid< N >::ParallelForEachCellIndex ( const std::function< void(const Vector< size_t, N > &)> & func ) const

Invokes the given function func for each grid cell in parallel.

This function invokes the given function object func for each grid cell in parallel manner. The input parameters are i and j indices of a grid cell. The order of execution can be arbitrary since it's multi-threaded.

◆ ParallelForEachCellIndex() [2/3]

template<size_t N>

template<size_t M = N>

std::enable_if_t<M == 2, void> CubbyFlow::Grid< N >::ParallelForEachCellIndex ( const std::function< void(size_t, size_t)> & func ) const

inline

◆ ParallelForEachCellIndex() [3/3]

template<size_t N>

template<size_t M = N>

std::enable_if_t<M == 3, void> CubbyFlow::Grid< N >::ParallelForEachCellIndex ( const std::function< void(size_t, size_t, size_t)> & func ) const

inline

◆ Resolution()

template<size_t N>

const Vector<size_t, N>& CubbyFlow::Grid< N >::Resolution ( ) const

Returns the grid resolution.

◆ SetData()

template<size_t N>

virtual void CubbyFlow::Grid< N >::SetData ( const ConstArrayView1< double > & data )

protectedpure virtual

Sets the data from a continuous linear array.

Implemented in CubbyFlow::FaceCenteredGrid< N >, CubbyFlow::ScalarGrid< N >, and CubbyFlow::CollocatedVectorGrid< N >.

◆ SetGrid()

template<size_t N>

void CubbyFlow::Grid< N >::SetGrid ( const Grid< N > & other )

protected

Sets the size parameters with given grid other.

◆ SetSizeParameters()

template<size_t N>

void CubbyFlow::Grid< N >::SetSizeParameters	(	const Vector< size_t, N > &	resolution,
		const Vector< double, N > &	gridSpacing,
		const Vector< double, N > &	origin
	)

protected

Sets the size parameters including the resolution, grid spacing, and origin.

◆ Swap()

template<size_t N>

virtual void CubbyFlow::Grid< N >::Swap ( Grid< N > * other )

pure virtual

Swaps the data with other grid.

Implemented in CubbyFlow::VertexCenteredScalarGrid< N >, CubbyFlow::VertexCenteredVectorGrid< N >, CubbyFlow::CellCenteredVectorGrid< N >, CubbyFlow::CellCenteredScalarGrid< N >, and CubbyFlow::FaceCenteredGrid< N >.

◆ SwapGrid()

template<size_t N>

void CubbyFlow::Grid< N >::SwapGrid ( Grid< N > * other )

protected

Swaps the size parameters with given grid other.

◆ TypeName()

template<size_t N>

virtual std::string CubbyFlow::Grid< N >::TypeName ( ) const

pure virtual

Returns the type name of derived grid.

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

Core/Grid/Grid.hpp

Public Member Functions

Protected Member Functions

Detailed Description

template<size_t N> class CubbyFlow::Grid< N >

Constructor & Destructor Documentation

◆ Grid() [1/3]

◆ ~Grid()

◆ Grid() [2/3]

◆ Grid() [3/3]

Member Function Documentation

◆ CellCenterPosition()

◆ ForEachCellIndex() [1/3]

◆ ForEachCellIndex() [2/3]

◆ ForEachCellIndex() [3/3]

◆ GetBoundingBox()

◆ GetData()

◆ GridSpacing()

◆ HasSameShape()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Origin()

◆ ParallelForEachCellIndex() [1/3]

◆ ParallelForEachCellIndex() [2/3]

◆ ParallelForEachCellIndex() [3/3]

◆ Resolution()

◆ SetData()

◆ SetGrid()

◆ SetSizeParameters()

◆ Swap()

◆ SwapGrid()

◆ TypeName()

template<size_t N>
class CubbyFlow::Grid< N >