Jet  v1.3.3
Public Member Functions | Protected Member Functions | List of all members
jet::CollocatedVectorGrid2 Class Referenceabstract

Abstract base class for 2-D collocated vector grid structure. More...

#include <jet/collocated_vector_grid2.h>

Inheritance diagram for jet::CollocatedVectorGrid2:
jet::VectorGrid2 jet::VectorField2 jet::Grid2 jet::Field2 jet::Serializable jet::CellCenteredVectorGrid2 jet::VertexCenteredVectorGrid2

Public Member Functions

 CollocatedVectorGrid2 ()
 Constructs an empty grid. More...
 
virtual ~CollocatedVectorGrid2 ()
 Default destructor. More...
 
virtual Size2 dataSize () const =0
 Returns the actual data point size. More...
 
virtual Vector2D dataOrigin () const =0
 Returns data position for the grid point at (0, 0). More...
 
const Vector2Doperator() (size_t i, size_t j) const
 Returns the grid data at given data point. More...
 
Vector2Doperator() (size_t i, size_t j)
 Returns the grid data at given data point. More...
 
double divergenceAtDataPoint (size_t i, size_t j) const
 Returns divergence at data point location. More...
 
double curlAtDataPoint (size_t i, size_t j) const
 Returns curl at data point location. More...
 
VectorDataAccessor dataAccessor ()
 Returns the read-write data array accessor. More...
 
ConstVectorDataAccessor constDataAccessor () const
 Returns the read-only data array accessor. More...
 
DataPositionFunc dataPosition () const
 Returns the function that maps data point to its position. 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 parallelly. More...
 
Vector2D sample (const Vector2D &x) const override
 Returns sampled value at given position x. More...
 
double divergence (const Vector2D &x) const override
 Returns divergence at given position x. More...
 
double curl (const Vector2D &x) const override
 Returns curl at given position x. More...
 
std::function< Vector2D(const Vector2D &)> sampler () const override
 Returns the sampler function. More...
 
- Public Member Functions inherited from jet::VectorGrid2
 VectorGrid2 ()
 Constructs an empty grid. More...
 
virtual ~VectorGrid2 ()
 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 initialValueX=0.0, double initialValueY=0.0)
 Resizes the grid using given parameters. More...
 
void resize (const Size2 &resolution, const Vector2D &gridSpacing=Vector2D(1, 1), const Vector2D &origin=Vector2D(), const Vector2D &initialValue=Vector2D())
 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...
 
virtual void fill (const Vector2D &value, ExecutionPolicy policy=ExecutionPolicy::kParallel)=0
 Fills the grid with given value. More...
 
virtual void fill (const std::function< Vector2D(const Vector2D &)> &func, ExecutionPolicy policy=ExecutionPolicy::kParallel)=0
 Fills the grid with given position-to-value mapping function. More...
 
virtual std::shared_ptr< VectorGrid2clone () const =0
 Returns the copy of the grid instance. 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 jet::VectorField2
 VectorField2 ()
 Default constructor. More...
 
virtual ~VectorField2 ()
 Default destructor. More...
 
- Public Member Functions inherited from jet::Field2
 Field2 ()
 
virtual ~Field2 ()
 
- Public Member Functions inherited from jet::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 Size2resolution () const
 Returns the grid resolution. More...
 
const Vector2Dorigin () const
 Returns the grid origin. More...
 
const Vector2DgridSpacing () const
 Returns the grid spacing. More...
 
const BoundingBox2DboundingBox () 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 parallelly. More...
 
bool hasSameShape (const Grid2 &other) const
 Returns true if resolution, grid-spacing and origin are same. More...
 
virtual void swap (Grid2 *other)=0
 Swaps the data with other grid. More...
 
- Public Member Functions inherited from jet::Serializable
 Serializable ()=default
 
virtual ~Serializable ()=default
 

Protected Member Functions

void swapCollocatedVectorGrid (CollocatedVectorGrid2 *other)
 Swaps the data storage and predefined samplers with given grid. More...
 
void setCollocatedVectorGrid (const CollocatedVectorGrid2 &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 jet::Grid2
void setSizeParameters (const Size2 &resolution, const Vector2D &gridSpacing, const Vector2D &origin)
 
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...
 

Additional Inherited Members

- Public Types inherited from jet::VectorGrid2
typedef ArrayAccessor2< Vector2DVectorDataAccessor
 Read-write array accessor type. More...
 
typedef ConstArrayAccessor2< Vector2DConstVectorDataAccessor
 Read-only array accessor type. More...
 
- Public Types inherited from jet::Grid2
typedef std::function< Vector2D(size_t, size_t)> DataPositionFunc
 Function type for mapping data index to actual position. More...
 

Detailed Description

Abstract base class for 2-D collocated vector grid structure.

Constructor & Destructor Documentation

◆ CollocatedVectorGrid2()

jet::CollocatedVectorGrid2::CollocatedVectorGrid2 ( )

Constructs an empty grid.

◆ ~CollocatedVectorGrid2()

virtual jet::CollocatedVectorGrid2::~CollocatedVectorGrid2 ( )
virtual

Default destructor.

Member Function Documentation

◆ constDataAccessor()

ConstVectorDataAccessor jet::CollocatedVectorGrid2::constDataAccessor ( ) const

Returns the read-only data array accessor.

◆ curl()

double jet::CollocatedVectorGrid2::curl ( const Vector2D x) const
overridevirtual

Returns curl at given position x.

Reimplemented from jet::VectorField2.

◆ curlAtDataPoint()

double jet::CollocatedVectorGrid2::curlAtDataPoint ( size_t  i,
size_t  j 
) const

Returns curl at data point location.

◆ dataAccessor()

VectorDataAccessor jet::CollocatedVectorGrid2::dataAccessor ( )

Returns the read-write data array accessor.

◆ dataOrigin()

virtual Vector2D jet::CollocatedVectorGrid2::dataOrigin ( ) const
pure virtual

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.

Implemented in jet::CellCenteredVectorGrid2, and jet::VertexCenteredVectorGrid2.

◆ dataPosition()

DataPositionFunc jet::CollocatedVectorGrid2::dataPosition ( ) const

Returns the function that maps data point to its position.

◆ dataSize()

virtual Size2 jet::CollocatedVectorGrid2::dataSize ( ) const
pure virtual

Returns the actual data point size.

Implemented in jet::CellCenteredVectorGrid2, and jet::VertexCenteredVectorGrid2.

◆ divergence()

double jet::CollocatedVectorGrid2::divergence ( const Vector2D x) const
overridevirtual

Returns divergence at given position x.

Reimplemented from jet::VectorField2.

◆ divergenceAtDataPoint()

double jet::CollocatedVectorGrid2::divergenceAtDataPoint ( size_t  i,
size_t  j 
) const

Returns divergence at data point location.

◆ forEachDataPointIndex()

void jet::CollocatedVectorGrid2::forEachDataPointIndex ( const std::function< void(size_t, size_t)> &  func) const

Invokes the given function func for each data point.

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

◆ getData()

void jet::CollocatedVectorGrid2::getData ( std::vector< double > *  data) const
overrideprotectedvirtual

Fetches the data into a continuous linear array.

Implements jet::Grid2.

◆ operator()() [1/2]

Vector2D& jet::CollocatedVectorGrid2::operator() ( size_t  i,
size_t  j 
)

Returns the grid data at given data point.

◆ operator()() [2/2]

const Vector2D& jet::CollocatedVectorGrid2::operator() ( size_t  i,
size_t  j 
) const

Returns the grid data at given data point.

◆ parallelForEachDataPointIndex()

void jet::CollocatedVectorGrid2::parallelForEachDataPointIndex ( const std::function< void(size_t, size_t)> &  func) const

Invokes the given function func for each data point parallelly.

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

◆ sample()

Vector2D jet::CollocatedVectorGrid2::sample ( const Vector2D x) const
overridevirtual

Returns sampled value at given position x.

Implements jet::VectorField2.

◆ sampler()

std::function<Vector2D(const Vector2D&)> jet::CollocatedVectorGrid2::sampler ( ) const
overridevirtual

Returns the sampler function.

This function returns the data sampler function object. The sampling function is linear.

Reimplemented from jet::VectorField2.

◆ setCollocatedVectorGrid()

void jet::CollocatedVectorGrid2::setCollocatedVectorGrid ( const CollocatedVectorGrid2 other)
protected

Sets the data storage and predefined samplers with given grid.

◆ setData()

void jet::CollocatedVectorGrid2::setData ( const std::vector< double > &  data)
overrideprotectedvirtual

Sets the data from a continuous linear array.

Implements jet::Grid2.

◆ swapCollocatedVectorGrid()

void jet::CollocatedVectorGrid2::swapCollocatedVectorGrid ( CollocatedVectorGrid2 other)
protected

Swaps the data storage and predefined samplers with given grid.


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