HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::Spatial::IRegularGrid3D Class Referenceabstract

The IRegularGrid3D class. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRegularGrid3D:
Collaboration diagram for HydroCouple::Spatial::IRegularGrid3D:

Public Member Functions

virtual ~IRegularGrid3D ()
 
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 int numZNodes () const =0
 numZNodes represents the number of nodes in the z 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 double zNodeLocation (int xNodeIndex, int yNodeIndex, int zNodeIndex) const =0
 zNodeLocation provides the z location coordinate for the x-node, y-node, and z-node indexes. More...
 
virtual bool isActive (int xCellIndex, int yCellIndex, int zCellIndex) const =0
 isActive is a bool indicating whether a cell is active. More...
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()
 
virtual QString id () const =0
 Gets a unique identifier for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()
 
virtual QString caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const QString &caption)=0
 Sets caption for the entity. More...
 
virtual QString description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const QString &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()
 

Additional Inherited Members

- Signals inherited from HydroCouple::IPropertyChanged
virtual void propertyChanged (const QString &propertyName)=0
 IPropertyChanged::propertyChanged() is called to emit signal/event when property of child class changes. More...
 

Detailed Description

The IRegularGrid3D class.

Constructor & Destructor Documentation

virtual HydroCouple::Spatial::IRegularGrid3D::~IRegularGrid3D ( )
inlinevirtual

Member Function Documentation

virtual RegularGridType HydroCouple::Spatial::IRegularGrid3D::gridType ( ) const
pure virtual

gridType

Returns
virtual bool HydroCouple::Spatial::IRegularGrid3D::isActive ( int  xCellIndex,
int  yCellIndex,
int  zCellIndex 
) const
pure virtual

isActive is a bool indicating whether a cell is active.

Parameters
xCellIndexthe x cell index for the cell. Must be less than numXNodes() - 1.
yCellIndexthe y cell index for the cell. Must be less than numYNodes() - 1.
zCellIndexthe z cell index for the cell. Must be less than numZNodes() - 1.
Returns
a bool indicating whether a cell is active.
virtual int HydroCouple::Spatial::IRegularGrid3D::numXNodes ( ) const
pure virtual

numXNodes represents the number of nodes in the x direction.

Returns
number of nodes in the x direction.
virtual int HydroCouple::Spatial::IRegularGrid3D::numYNodes ( ) const
pure virtual

numYNodes represents the number of nodes in the y direction.

Returns
number of nodes in the y direction.
virtual int HydroCouple::Spatial::IRegularGrid3D::numZNodes ( ) const
pure virtual

numZNodes represents the number of nodes in the z direction.

Returns
number of nodes in the z direction.
virtual double HydroCouple::Spatial::IRegularGrid3D::xNodeLocation ( int  xNodeIndex,
int  yNodeIndex 
) const
pure virtual

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

Parameters
xNodeIndexthe x-node index.
yNodeIndexthe y-node index
Returns
returns x location coordinate for the x-node and y-node provided
virtual double HydroCouple::Spatial::IRegularGrid3D::yNodeLocation ( int  xNodeIndex,
int  yNodeIndex 
) const
pure virtual

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

Parameters
xNodeIndexthe x-node index.
yNodeIndexthe y-node index
Returns
returns y location coordinate for the x-node and y-node provided
virtual double HydroCouple::Spatial::IRegularGrid3D::zNodeLocation ( int  xNodeIndex,
int  yNodeIndex,
int  zNodeIndex 
) const
pure virtual

zNodeLocation provides the z location coordinate for the x-node, y-node, and z-node indexes.

Parameters
xNodeIndexthe x-node index.
yNodeIndexthe y-node index
zNodeIndexthe z-node index
Returns
returns z location coordinate for the x-node, y-node, and z-node indexes.

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