HydroCouple::Spatial::IRegularGrid2D Class Reference

The IRegularGrid2D class. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRegularGrid2D:

Collaboration diagram for HydroCouple::Spatial::IRegularGrid2D:

Public Member Functions
virtual	~IRegularGrid2D ()=0
	IRegularGrid2D destructor. More...
virtual RegularGridType	gridType () const =0
	gridType More...
virtual int	numXNodes () const =0
	numXNodes represents the number of nodes in the x direction. More...
virtual int	numYNodes () const =0
	numYNodes represents the number of nodes in the y direction. More...
virtual double	xNodeLocation (int xNodeIndex, int yNodeIndex) const =0
	xNodeLocation provides the x location coordinate for the x-node and y-node indexes. More...
virtual double	yNodeLocation (int xNodeIndex, int yNodeIndex) const =0
	yNodeLocation provides the x location coordinate for the x-node and y-node indexes. More...
virtual bool	isActive (int xCellIndex, int yCellIndex) const =0
	isActive is a bool indicating whether a cell is active. More...
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=0
	IIdentity::~IIdentity is a virtual destructor. More...
virtual string	id () const =0
	Gets a unique identifier for the entity. More...
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=0
	IDescription::~IDescription is a virtual destructor. More...
virtual string	caption () const =0
	Gets caption for the entity. More...
virtual void	setCaption (const string &caption)=0
	Sets caption for the entity. More...
virtual string	description () const =0
	Gets additional descriptive information for the entity. More...
virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity. More...
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=0
	IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
virtual void	registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
	IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
virtual void	deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
	IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...

Detailed Description

The IRegularGrid2D class.

Constructor & Destructor Documentation

~IRegularGrid2D()

virtual HydroCouple::Spatial::IRegularGrid2D::~IRegularGrid2D ( )

pure virtual

IRegularGrid2D destructor.

Member Function Documentation

gridType()

virtual RegularGridType HydroCouple::Spatial::IRegularGrid2D::gridType ( ) const

pure virtual

gridType

Returns

isActive()

virtual bool HydroCouple::Spatial::IRegularGrid2D::isActive ( int  xCellIndex, int  yCellIndex  ) const

pure virtual

isActive is a bool indicating whether a cell is active.

Parameters

xCellIndex	the x cell index for the cell. Must be less than numXNodes() - 1.
yCellIndex	the y cell index for the cell. Must be less than numYNodes() - 1.

Returns

a bool indicating whether a cell is active.

numXNodes()

virtual int HydroCouple::Spatial::IRegularGrid2D::numXNodes ( ) const

pure virtual

numXNodes represents the number of nodes in the x direction.

Returns

number of nodes in the x direction.

numYNodes()

virtual int HydroCouple::Spatial::IRegularGrid2D::numYNodes ( ) const

pure virtual

numYNodes represents the number of nodes in the y direction.

Returns

number of nodes in the y direction.

xNodeLocation()

virtual double HydroCouple::Spatial::IRegularGrid2D::xNodeLocation ( int  xNodeIndex, int  yNodeIndex  ) const

pure virtual

xNodeLocation provides the x location coordinate for the x-node and y-node indexes.

Parameters

xNodeIndex	the x-node index.
yNodeIndex	the y-node index

Returns

returns x location coordinate for the x-node and y-node provided

yNodeLocation()

virtual double HydroCouple::Spatial::IRegularGrid2D::yNodeLocation ( int  xNodeIndex, int  yNodeIndex  ) const

pure virtual

yNodeLocation provides the x location coordinate for the x-node and y-node indexes.

Parameters

xNodeIndex	the x-node index.
yNodeIndex	the y-node index

Returns

returns y location coordinate for the x-node and y-node provided

---

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

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouplespatial.h