2-D Vertex-centered scalar grid structure. More...

#include <Core/Grid/VertexCenteredScalarGrid2.h>

Inheritance diagram for CubbyFlow::VertexCenteredScalarGrid2:

Classes
class	Builder
	A grid builder class that returns 2-D vertex-centered scalar grid. More...

Public Member Functions
	VertexCenteredScalarGrid2 ()
	Constructs zero-sized grid. More...

	VertexCenteredScalarGrid2 (size_t resolutionX, size_t resolutionY, double gridSpacingX=1.0, double gridSpacingY=1.0, double originX=0.0, double originY=0.0, double initialValue=0.0)

	VertexCenteredScalarGrid2 (const Size2 &resolution, const Vector2D &gridSpacing=Vector2D(1.0, 1.0), const Vector2D &origin=Vector2D(), double initialValue=0.0)

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

Size2	GetDataSize () const override
	Returns the actual data point size. More...

Vector2D	GetDataOrigin () const override

std::shared_ptr< ScalarGrid2 >	Clone () const override
	Returns the copy of the grid instance. More...

void	Swap (Grid2 *other) override
	Swaps the contents with the given `other` grid. More...

void	Set (const VertexCenteredScalarGrid2 &other)
	Sets the contents with the given `other` grid. More...

VertexCenteredScalarGrid2 &	operator= (const VertexCenteredScalarGrid2 &other)
	Sets the contents with the given `other` grid. More...

Public Member Functions inherited from CubbyFlow::ScalarGrid2
	ScalarGrid2 ()
	Constructs an empty grid. More...

virtual	~ScalarGrid2 ()
	Default destructor. More...

void	Clear ()
	Clears the contents of the grid. More...

void	Resize (size_t resolutionX, size_t resolutionY, double gridSpacingX=1.0, double gridSpacingY=1.0, double originX=0.0, double originY=0.0, double initialValue=0.0)
	Resizes the grid using given parameters. More...

void	Resize (const Size2 &resolution, const Vector2D &gridSpacing=Vector2D(1, 1), const Vector2D &origin=Vector2D(), double initialValue=0.0)
	Resizes the grid using given parameters. More...

void	Resize (double gridSpacingX, double gridSpacingY, double originX, double originY)
	Resizes the grid using given parameters. More...

void	Resize (const Vector2D &gridSpacing, const Vector2D &origin)
	Resizes the grid using given parameters. More...

const double &	operator() (size_t i, size_t j) const
	Returns the grid data at given data point. More...

double &	operator() (size_t i, size_t j)
	Returns the grid data at given data point. More...

Vector2D	GradientAtDataPoint (size_t i, size_t j) const
	Returns the gradient vector at given data point. More...

double	LaplacianAtDataPoint (size_t i, size_t j) const
	Returns the Laplacian at given data point. More...

ScalarDataAccessor	GetDataAccessor ()
	Returns the read-write data array accessor. More...

ConstScalarDataAccessor	GetConstDataAccessor () const
	Returns the read-only data array accessor. More...

DataPositionFunc	GetDataPosition () const
	Returns the function that maps data point to its position. More...

void	Fill (double value, ExecutionPolicy policy=ExecutionPolicy::Parallel)
	Fills the grid with given value. More...

void	Fill (const std::function< double(const Vector2D &)> &func, ExecutionPolicy policy=ExecutionPolicy::Parallel)
	Fills the grid with given position-to-value mapping function. More...

void	ForEachDataPointIndex (const std::function< void(size_t, size_t)> &func) const
	Invokes the given function `func` for each data point. More...

void	ParallelForEachDataPointIndex (const std::function< void(size_t, size_t)> &func) const
	Invokes the given function `func` for each data point in parallel. More...

double	Sample (const Vector2D &x) const override
	Returns the sampled value at given position `x`. More...

std::function< double(const Vector2D &)>	Sampler () const override
	Returns the sampler function. More...

Vector2D	Gradient (const Vector2D &x) const override
	Returns the gradient vector at given position `x`. More...

double	Laplacian (const Vector2D &x) const override
	Returns the Laplacian at given position `x`. More...

void	Serialize (std::vector< uint8_t > *buffer) const override
	Serializes the grid instance to the output buffer. More...

void	Deserialize (const std::vector< uint8_t > &buffer) override
	Deserializes the input buffer to the grid instance. More...

Public Member Functions inherited from CubbyFlow::ScalarField2
	ScalarField2 ()
	Default constructor. More...

virtual	~ScalarField2 ()
	Default destructor. More...

Public Member Functions inherited from CubbyFlow::Field2
	Field2 ()

virtual	~Field2 ()

Public Member Functions inherited from CubbyFlow::Grid2
	Grid2 ()
	Constructs an empty grid. More...

virtual	~Grid2 ()
	Default destructor. More...

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

const Size2 &	Resolution () const
	Returns the grid resolution. More...

const Vector2D &	Origin () const
	Returns the grid origin. More...

const Vector2D &	GridSpacing () const
	Returns the grid spacing. More...

const BoundingBox2D &	BoundingBox () const
	Returns the bounding box of the grid. More...

DataPositionFunc	CellCenterPosition () const
	Returns the function that maps grid index to the cell-center position. More...

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

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

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

Static Public Member Functions
static Builder	GetBuilder ()
	Returns builder fox VertexCenteredScalarGrid2. More...

Additional Inherited Members
Public Types inherited from CubbyFlow::ScalarGrid2
using	ScalarDataAccessor = ArrayAccessor2< double >
	Read-write array accessor type. More...

using	ConstScalarDataAccessor = ConstArrayAccessor2< double >
	Read-only array accessor type. More...

Public Types inherited from CubbyFlow::Grid2
using	DataPositionFunc = std::function< Vector2D(size_t, size_t)>
	Function type for mapping data index to actual position. More...

Protected Member Functions inherited from CubbyFlow::ScalarGrid2
void	SwapScalarGrid (ScalarGrid2 *other)
	Swaps the data storage and predefined samplers with given grid. More...

void	SetScalarGrid (const ScalarGrid2 &other)
	Sets the data storage and predefined samplers with given grid. More...

void	GetData (std::vector< double > *data) const override
	Fetches the data into a continuous linear array. More...

void	SetData (const std::vector< double > &data) override
	Sets the data from a continuous linear array. More...

Protected Member Functions inherited from CubbyFlow::Grid2
void	SetSizeParameters (const Size2 &resolution, const Vector2D &gridSpacing, const Vector2D &origin)
	Sets the size parameters including the resolution, grid spacing, and origin. More...

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

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

Detailed Description

2-D Vertex-centered scalar grid structure.

This class represents 2-D vertex-centered scalar grid which extends ScalarGrid2. As its name suggests, the class defines the data point at the grid vertices (corners). Thus, A x B grid resolution will have (A+1) x (B+1) data points.

Constructor & Destructor Documentation

◆ VertexCenteredScalarGrid2() [1/4]

CubbyFlow::VertexCenteredScalarGrid2::VertexCenteredScalarGrid2 ( )

Constructs zero-sized grid.

◆ VertexCenteredScalarGrid2() [2/4]

CubbyFlow::VertexCenteredScalarGrid2::VertexCenteredScalarGrid2	(	size_t	resolutionX,
		size_t	resolutionY,
		double	gridSpacingX = `1.0`,
		double	gridSpacingY = `1.0`,
		double	originX = `0.0`,
		double	originY = `0.0`,
		double	initialValue = `0.0`
	)

Constructs a grid with given resolution, grid spacing, origin and initial value.

◆ VertexCenteredScalarGrid2() [3/4]

CubbyFlow::VertexCenteredScalarGrid2::VertexCenteredScalarGrid2	(	const Size2 &	resolution,
		const Vector2D &	gridSpacing = `Vector2D(1.0, 1.0)`,
		const Vector2D &	origin = `Vector2D()`,
		double	initialValue = `0.0`
	)

Constructs a grid with given resolution, grid spacing, origin and initial value.

◆ VertexCenteredScalarGrid2() [4/4]

CubbyFlow::VertexCenteredScalarGrid2::VertexCenteredScalarGrid2 ( const VertexCenteredScalarGrid2 & other )

Copy constructor.

Member Function Documentation

◆ Clone()

std::shared_ptr<ScalarGrid2> CubbyFlow::VertexCenteredScalarGrid2::Clone ( ) const

overridevirtual

Returns the copy of the grid instance.

Implements CubbyFlow::ScalarGrid2.

◆ GetBuilder()

static Builder CubbyFlow::VertexCenteredScalarGrid2::GetBuilder ( )

static

Returns builder fox VertexCenteredScalarGrid2.

◆ GetDataOrigin()

Vector2D CubbyFlow::VertexCenteredScalarGrid2::GetDataOrigin ( ) const

overridevirtual

Returns data position for the grid point at (0, 0). Note that this is different from origin() since origin() returns the lower corner point of the bounding box.

Implements CubbyFlow::ScalarGrid2.

◆ GetDataSize()

Size2 CubbyFlow::VertexCenteredScalarGrid2::GetDataSize ( ) const

overridevirtual

Returns the actual data point size.

Implements CubbyFlow::ScalarGrid2.

◆ operator=()

VertexCenteredScalarGrid2& CubbyFlow::VertexCenteredScalarGrid2::operator= ( const VertexCenteredScalarGrid2 & other )

Sets the contents with the given other grid.

◆ Set()

void CubbyFlow::VertexCenteredScalarGrid2::Set ( const VertexCenteredScalarGrid2 & other )

Sets the contents with the given other grid.

◆ Swap()

void CubbyFlow::VertexCenteredScalarGrid2::Swap ( Grid2 * other )

overridevirtual

Swaps the contents with the given other grid.

This function swaps the contents of the grid instance with the given grid object other only if other has the same type with this grid.

Implements CubbyFlow::Grid2.

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

Core/Grid/VertexCenteredScalarGrid2.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VertexCenteredScalarGrid2() [1/4]

◆ VertexCenteredScalarGrid2() [2/4]

◆ VertexCenteredScalarGrid2() [3/4]

◆ VertexCenteredScalarGrid2() [4/4]

Member Function Documentation

◆ Clone()

◆ GetBuilder()

◆ GetDataOrigin()

◆ GetDataSize()

◆ operator=()

◆ Set()

◆ Swap()