CGeomRasterGrid Class Reference

Geometry cass used to represent the raster grid of cell objects. More...

#include <raster_grid.h>

Public Member Functions
	CGeomRasterGrid (CSimulation *)
	Constructor.
	~CGeomRasterGrid (void)
	Destructor.
CSimulation *	pGetSim (void)
	Returns a pointer to the simulation object.
int	nCreateGrid (void)
	Creates the 2D CGeomCell array.

Private Attributes
double	m_dD50Fine
	The d50 of fine-sized sediment.
double	m_dD50Sand
	The d50 of sand-sized sediment.
double	m_dD50Coarse
	The d50 of coarse-sized sediment.
CSimulation *	m_pSim
	A pointer to the CSimulation object.
CGeomCell **	m_Cell
	The 2D array of m_Cell objects. A c-style 2D array seems to be faster than using 2D STL vectors.

Friends
class	CSimulation
	The CSimulation class is a friend of the CGeomRasterGrid class.
class	CGeomProfile
	The CGeomProfile class is a friend of the CGeomRasterGrid class.

Detailed Description

Geometry cass used to represent the raster grid of cell objects.

TODO 001 This is a more detailed description of the CGeomRasterGrid class.

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License *

Definition at line 34 of file raster_grid.h.

Constructor & Destructor Documentation

CGeomRasterGrid()

CGeomRasterGrid::CGeomRasterGrid ( CSimulation * pSimIn )

explicit

Constructor.

Definition at line 33 of file raster_grid.cpp.

~CGeomRasterGrid()

CGeomRasterGrid::~CGeomRasterGrid

(

void

)

Destructor.

Definition at line 43 of file raster_grid.cpp.

Member Function Documentation

nCreateGrid()

int CGeomRasterGrid::nCreateGrid

(

void

)

Creates the 2D CGeomCell array.

Definition at line 66 of file raster_grid.cpp.

pGetSim()

CSimulation * CGeomRasterGrid::pGetSim

(

void

)

Returns a pointer to the simulation object.

Definition at line 55 of file raster_grid.cpp.

Friends And Related Symbol Documentation

CGeomProfile

friend class CGeomProfile

friend

The CGeomProfile class is a friend of the CGeomRasterGrid class.

Definition at line 40 of file raster_grid.h.

Referenced by CGeomProfile.

CSimulation

friend class CSimulation

friend

The CSimulation class is a friend of the CGeomRasterGrid class.

Definition at line 37 of file raster_grid.h.

Referenced by CGeomRasterGrid(), CSimulation, and pGetSim().

Field Documentation

m_Cell

CGeomCell** CGeomRasterGrid::m_Cell

private

The 2D array of m_Cell objects. A c-style 2D array seems to be faster than using 2D STL vectors.

Definition at line 56 of file raster_grid.h.

Referenced by CGeomRasterGrid(), nCreateGrid(), CGeomProfile::nGetCellGivenDepth(), and ~CGeomRasterGrid().

m_dD50Coarse

double CGeomRasterGrid::m_dD50Coarse

private

The d50 of coarse-sized sediment.

Definition at line 50 of file raster_grid.h.

Referenced by CGeomRasterGrid().

m_dD50Fine

double CGeomRasterGrid::m_dD50Fine

private

The d50 of fine-sized sediment.

Definition at line 44 of file raster_grid.h.

Referenced by CGeomRasterGrid().

m_dD50Sand

double CGeomRasterGrid::m_dD50Sand

private

The d50 of sand-sized sediment.

Definition at line 47 of file raster_grid.h.

Referenced by CGeomRasterGrid().

m_pSim

CSimulation* CGeomRasterGrid::m_pSim

private

A pointer to the CSimulation object.

Definition at line 53 of file raster_grid.h.

Referenced by CGeomRasterGrid(), nCreateGrid(), pGetSim(), and ~CGeomRasterGrid().

---

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

• raster_grid.h
• raster_grid.cpp