A 2 dimensional, horizontal grid of GirdProfile objects. More...

#include <GridSLBM.h>

Public Member Functions
	GridSLBM ()
	Default constructor. More...

	~GridSLBM ()
	Destructor. More...

void	clear ()
	Clears and releases all memory held by this GridSLBM object. More...

void	loadFromFile (const string &filename)
	Load the depth, velocity and gradient information from an ascii flat file. More...

void	loadFromDirectory (const string &dirName)
	Load the depth, velocity and gradient information from binary files in specified directory. More...

void	loadFromDataBuffer (util::DataBuffer &buffer)
	Load the depth, velocity and gradient information from DataBuffer. More...

void	saveVelocityModel (const string &destination, const int &format)
	Save the Earth model currently in memory, to file(s) More...

void	saveVelocityModel (util::DataBuffer &buffer)
	Save the Earth model currently in memory, to a DataBuffer. More...

int	getBufferSize () const

double	getAverageMantleVelocity (const int &waveType)
	Retreive the average P or S wave velocity of the mantle, in km/sec. More...

void	setAverageMantleVelocity (const int &waveType, const double &velocity)
	Retreive the average P or S wave velocity of the mantle, in km/sec. More...

virtual bool	findProfile (Location &location, vector< GridProfile * > &neighbors, vector< int > &nodeIds, vector< double > &coefficients)
	Find the neighboring GridProfile objects and associated interpolation coefficients at a specified Location. More...

void	getNodeNeighbors (const int &nodeId, int neighbors[], int &nNeighbors)
	Retrieve the grid node id of the nodes that are direct neighbors of the specified grid node. More...

void	getNodeNeighbors (const int &nodeId, vector< int > &neighbors)
	Retrieve the grid node ids of the nodes that are direct neighbors of the specified grid node. More...

void	getActiveNodeNeighbors (const int &nodeid, int neighbors[], int &nNeighbors)

void	getActiveNodeNeighbors (const int &nodeid, vector< int > &neighbors)

size_t	memSize ()

string	getTessId ()

int	addGeoStack (GeoStack *geoStack)

string	toString ()

void	setInterpolatorType (const string &interpolatorType)

string	getInterpolatorType ()

Public Member Functions inherited from slbm::Grid
	Grid ()
	Default constructor. More...

virtual	~Grid ()
	Destructor. More...

virtual bool	operator== (const Grid &other)
	Equality operator. More...

virtual bool	operator!= (const Grid &other)
	Inequality operator. More...

virtual bool	is_directory (const string &dir)

virtual int	getNNodes ()
	Retrieve the number of nodes in the model. More...

virtual int	getNIntervals ()
	Retrieve the number of intervals in each Profile. More...

virtual GridProfile *	getProfile (const int &nodeId)
	Retrieve a pointer to the GridProfile that is node (i, j) in this Grid. More...

virtual GreatCircle *	getGreatCircle (const int &phase, const double &latSource, const double &lonSource, const double &depthSource, const double &latReceiver, const double &lonReceiver, const double &depthReceiver, const double &delta, const double &ch_max)
	Retrieve a GreatCircle object between a source and a receiver. More...

virtual CrustalProfile *	getReceiverProfile (const int &phase, const double &lat, const double &lon, const double &depth)
	Retrieve a CrustalProfile containing data appropriate for the specified phase at the specified location. More...

virtual CrustalProfile *	getSourceProfile (const int &phase, const double &lat, const double &lon, const double &depth)

virtual void	clearCrustalProfiles ()
	Delete all the CrustalProfile objects managed by this Grid. More...

virtual LayerProfile *	getLayerProfile (GreatCircle *greatCircle, Location &location)
	Retrieve a LayerProfile containing data appropriate for the specified GreatCircle, at the specified geographic latitude and longitude. More...

virtual QueryProfile *	getQueryProfile (Location &location)
	Retrieve a QueryProfile containing all available model information, at the latitude and longitude of the specified Location. More...

vector< vector< Uncertainty * > > &	getUncertainty ()

Uncertainty &	getUncertainty (int phase, int attribute)

virtual int	getNCrustalProfiles ()

void	initializeActiveNodes (double activeNodeLatMin, double activeNodeLonMin, double activeNodeLatMax, double activeNodeLonMax)
	Specify the latitude, longitude range in radians that will define which grid nodes are also active nodes. More...

void	initializeActiveNodes (GeoTessPolygon *polygon)
	Specify the Polygon that will define which grid nodes are also active nodes. More...

virtual int	getNActiveNodes ()
	Retrieve the number of active nodes. More...

void	clearActiveNodes ()

virtual int	getGridNodeId (int activeNodeId)
	Retrieve the grid node id that corresponds to a specified active node id. More...

virtual int	getActiveNodeId (int nodeId)
	Retrieve the grid node id that corresponds to a specified active node id. More...

virtual void	getNodeNeighborInfo (const int &nodeId, int neighbors[], double distance[], double azimuth[], int &nNeighbors)
	Retrieve the grid node id of the nodes that are direct neighbors of the specified grid node. More...

virtual void	getNodeNeighborInfo (const int &nodeId, vector< int > &neighbors, vector< double > &distance, vector< double > &azimuth)
	Retrieve the grid node id of the nodes that are direct neighbors of the specified grid node. More...

virtual void	getActiveNodeNeighborInfo (const int &nid, int neighbors[], double distance[], double azimuth[], int &nNeighbors)

virtual void	getActiveNodeNeighborInfo (const int &nid, vector< int > &neighbors, vector< double > &distance, vector< double > &azimuth)

virtual void	getNodeSeparation (const int &node1, const int &node2, double &distance)
	Retrieve the angular separation in radians between any pair of. More...

virtual void	getNodeAzimuth (const int &node1, const int &node2, double &azimuth)
	Retrieve the azimuth in radians from one grid node to another. More...

virtual void	getNodeHitCount (const int &nodeId, int &hitCount)

virtual void	clearNodeHitCount ()

virtual size_t	memSizeCrustalProfiles ()

string &	getModelPath ()

const string	getOutputDirectory ()

void	specifyOutputDirectory (const string &outputDir)

Static Public Member Functions
static string	class_name ()

Static Public Member Functions inherited from slbm::Grid
static Grid *	getGrid (const string &modelDirectory)

static Grid *	getGrid (util::DataBuffer &buffer)

static bool	fileExists (const string &fileName)

static string	class_name ()

Private Member Functions
int	getGeoStacksSize ()

vector< GeoStack * > &	getGeoStacks ()

vector< Triangle * > &	getTriangles ()

void	readGeoStacks (util::DataBuffer &buffer)

void	readConnectivity (util::DataBuffer &buffer, int &nNodes, vector< float > &elev, vector< float > &waterThick, vector< int > &stackId)

void	readTessellationData (util::DataBuffer &buffer, int nNodes, const vector< float > &elev, const vector< float > &waterThick, const vector< int > &stackId, vector< vector< Triangle * > > &triset)

void	defineTessAdjacency (int nNodes, const vector< vector< Triangle * > > &triset)

Triangle *	findTriangle (const Location &location, vector< double > &coefficients)

void	findSpecialTriangles ()

void	saveSlbmFile (const string &fileName)

void	saveSlbmDirectory (const string &directoryName)

void	saveGeotessFile (const string &fileName)

void	saveGeotessDirectory (const string &directoryName)

void	saveGeotess (const string &path, const string &pathToGrid, const string &gridFilePath)

Private Attributes
string	tessId

vector< GeoStack * >	geoStacks

vector< Triangle * >	triangles

vector< Triangle * >	specialTriangles

double	cos_min

double	V0 [2]
	The average P and S wave velocity of the mantle. More...

Additional Inherited Members
Protected Member Functions inherited from slbm::Grid
void	writeBufferToFile (util::DataBuffer &buffer, string fileName)

void	reaDataBuffererFromFile (util::DataBuffer &buffer, string dirname, string fileName)

Protected Attributes inherited from slbm::Grid
string	modelPath
	The name of the file or directory from which the velocity model was loaded. More...

vector< GridProfile * >	profiles
	The GridProfile objects which constitute the nodes in a Grid object. More...

vector< int >	activeNodes

GeoTessPolygon *	polygon

CrustalProfileStore *	sources

CrustalProfileStore *	receivers

vector< vector< Uncertainty * > >	uncertainty

Detailed Description

A 2 dimensional, horizontal grid of GridProfile objects.

When an application or another object in the slbm library requests a CrustalProfile object by calling GridSLBM::getCrustalProfile() GridSLBM will check to see if it already has a pointer to a CrustalProfile object for the same phase and at the same Location. If it does, it will return a pointer to the existing CrustalProfile object. If it does not, it will create a new CrustalProfile object and return that. The map of crustalProfiles can be cleared by calling clearCrustalProfiles(). The CrustalProfile objects owned by a GridSLBM object are deleted in the GridSLBM destructor.

Constructor & Destructor Documentation

slbm::GridSLBM::GridSLBM ( )

Default constructor.

slbm::GridSLBM::~GridSLBM ( )

Destructor.

Member Function Documentation

int slbm::GridSLBM::addGeoStack ( GeoStack * geoStack )

inlinevirtual

Reimplemented from slbm::Grid.

static string slbm::GridSLBM::class_name ( )

inlinestatic

Returns the class name.

void slbm::GridSLBM::clear ( )

virtual

Clears and releases all memory held by this GridSLBM object.

Reimplemented from slbm::Grid.

void slbm::GridSLBM::defineTessAdjacency	(	int	nNodes,
		const vector< vector< Triangle * > > &	triset
	)

private

bool slbm::GridSLBM::findProfile	(	Location &	location,
		vector< GridProfile * > &	neighbors,
		vector< int > &	nodeIds,
		vector< double > &	coefficients
	)

inlinevirtual

Given a Location, find the GridProfile objects that surround the Location and compute the interpolation coefficient for each of those surrounding GridProfile objects. Interpolated values will equal the sum of the values at the GridProfile objects times the corresponding interpolation coefficient.

This method is called by getCrustalProfile() and getMantleProfile() to compute InterpolatedProfile objects.

Parameters

location	the Location of the desired profile.
neighbors	the GridProfile objects which surround the specified Location.
nodeIds	the node indices of the neighbors
coefficients	the interpolation coefficient corresponding to each neighbor.

Returns: true if successful, false if location is outside valid range of the model.

Reimplemented from slbm::Grid.

void slbm::GridSLBM::findSpecialTriangles ( )

private

Triangle * slbm::GridSLBM::findTriangle	(	const Location &	location,
		vector< double > &	coefficients
	)

inlineprivate

void slbm::GridSLBM::getActiveNodeNeighbors	(	const int &	nodeid,
		int	neighbors[],
		int &	nNeighbors
	)

virtual

Reimplemented from slbm::Grid.

void slbm::GridSLBM::getActiveNodeNeighbors	(	const int &	nodeid,
		vector< int > &	neighbors
	)

virtual

Reimplemented from slbm::Grid.

double slbm::GridSLBM::getAverageMantleVelocity ( const int & waveType )

inlinevirtual

Retreive the average P or S wave velocity of the mantle. These values are retrieved from the header information in the velocity model file.

Parameters

waveType either SLBMGlobals::PWAVE or SLBMGlobals::SWAVE.

Returns: the average P or S wave mantle velocity, in km/sec.

Reimplemented from slbm::Grid.

int slbm::GridSLBM::getBufferSize ( ) const

virtual

Reimplemented from slbm::Grid.

vector<GeoStack*>& slbm::GridSLBM::getGeoStacks ( )

inlineprivate

int slbm::GridSLBM::getGeoStacksSize ( )

inlineprivate

string slbm::GridSLBM::getInterpolatorType ( )

inlinevirtual

Reimplemented from slbm::Grid.

void slbm::GridSLBM::getNodeNeighbors	(	const int &	nodeId,
		int	neighbors[],
		int &	nNeighbors
	)

virtual

Retrieve the grid node id of the nodes that are direct neighbors of the specified grid node.

Reimplemented from slbm::Grid.

void slbm::GridSLBM::getNodeNeighbors	(	const int &	nodeId,
		vector< int > &	neighbors
	)

virtual

Retrieve the grid node ids of the nodes that are direct neighbors of the specified grid node.

Reimplemented from slbm::Grid.

string slbm::GridSLBM::getTessId ( )

inlinevirtual

Reimplemented from slbm::Grid.

vector<Triangle*>& slbm::GridSLBM::getTriangles ( )

inlineprivate

void slbm::GridSLBM::loadFromDataBuffer ( util::DataBuffer & buffer )

virtual

Load the Earth model information from DataBuffer

Parameters

buffer the DataBuffer from which to load the model

Reimplemented from slbm::Grid.

void slbm::GridSLBM::loadFromDirectory ( const string & dirName )

virtual

Load the Earth model information from binary files in specified directory

Parameters

dirName the name of directory from which to load the model

Reimplemented from slbm::Grid.

void slbm::GridSLBM::loadFromFile ( const string & filename )

virtual

Load the Earth model information from an ascii flat file.

Parameters

filename the name of the ascii flat file containing the data.

Reimplemented from slbm::Grid.

size_t slbm::GridSLBM::memSize ( )

virtual

Reimplemented from slbm::Grid.

void slbm::GridSLBM::readConnectivity	(	util::DataBuffer &	buffer,
		int &	nNodes,
		vector< float > &	elev,
		vector< float > &	waterThick,
		vector< int > &	stackId
	)

private

void slbm::GridSLBM::readGeoStacks ( util::DataBuffer & buffer )

private

void slbm::GridSLBM::readTessellationData	(	util::DataBuffer &	buffer,
		int	nNodes,
		const vector< float > &	elev,
		const vector< float > &	waterThick,
		const vector< int > &	stackId,
		vector< vector< Triangle * > > &	triset
	)

private

void slbm::GridSLBM::saveGeotess	(	const string &	path,
		const string &	pathToGrid,
		const string &	gridFilePath
	)

private

void slbm::GridSLBM::saveGeotessDirectory ( const string & directoryName )

private

void slbm::GridSLBM::saveGeotessFile ( const string & fileName )

private

void slbm::GridSLBM::saveSlbmDirectory ( const string & directoryName )

private

void slbm::GridSLBM::saveSlbmFile ( const string & fileName )

private

void slbm::GridSLBM::saveVelocityModel	(	const string &	destination,
		const int &	format
	)

virtual

Save the Earth model currently in memory, to to file(s) An exception will be thrown if the speficied filename is the same as the name of the file from which the Earth model was originally loaded with loadVelocityModel()

Parameters

destination	the name of the file or directory where the model information is to be saved.
format	integer in range 1 to 4

Reimplemented from slbm::Grid.

void slbm::GridSLBM::saveVelocityModel ( util::DataBuffer & buffer )

virtual

Save the Earth model currently in memory, to to a DataBuffer.

Parameters

buffer the DataBuffer to which to save the model

Reimplemented from slbm::Grid.

void slbm::GridSLBM::setAverageMantleVelocity	(	const int &	waveType,
		const double &	velocity
	)

inlinevirtual

Retreive the average P or S wave velocity of the mantle. These values are retrieved from the header information in the velocity model file.

Parameters

waveType	either SLBMGlobals::PWAVE or SLBMGlobals::SWAVE.
velocity	(output) the average P or S wave mantle velocity, in km/sec.

Reimplemented from slbm::Grid.

void slbm::GridSLBM::setInterpolatorType ( const string & interpolatorType )

inlinevirtual

Reimplemented from slbm::Grid.

string slbm::GridSLBM::toString ( )

virtual

Reimplemented from slbm::Grid.

Member Data Documentation

double slbm::GridSLBM::cos_min

private

vector<GeoStack*> slbm::GridSLBM::geoStacks

private

vector<Triangle*> slbm::GridSLBM::specialTriangles

private

string slbm::GridSLBM::tessId

private

vector<Triangle*> slbm::GridSLBM::triangles

private

double slbm::GridSLBM::V0[2]

private

The average P and S wave velocity of the mantle. These values are retrieved from the header information in the velocity model file.

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

/Users/sballar/work/RSTT/SLBM_Root.3.0.5/install/SLBM_Root.3.0.5.MacOSX/SLBM/include/GridSLBM.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation