GmpAnalyticalProcess Class Reference

Basic class for the analytical process plugin object. More...

#include <gmpAnalyticalProcess.h>

Inheritance diagram for GmpAnalyticalProcess:

Collaboration diagram for GmpAnalyticalProcess:

Public Member Functions
	GmpAnalyticalProcess (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)
	Constructor. Will be called by the plugin loading code.
virtual	~GmpAnalyticalProcess ()
	Destructor.
virtual const char *	pluginName () const
virtual const char *	pluginType () const
virtual void	loadFunctions (LuaTable &table)
virtual QStringList	functionList () const
Public Member Functions inherited from GmProcess
	GmProcess (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)
virtual const char *	pluginCategory () const
virtual bool	loadPrivateData (LuaTable &table)
virtual void	printParameters (const GmLogCategory &logger)
int	createProgressStatsItem (GmRunProgressStats *ps, const char *name)
Public Member Functions inherited from GmPluginObject
	GmPluginObject (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)
QString	id () const
QString	description () const
QString	pluginTypeName () const

Private Member Functions
GmProcessMethodRedirector< GmpAnalyticalProcess >::MethodRegistry *	processMethodTable () const
	Returns the table storing the process exported function names / methods.
int	init (lua_State *L)
	The analytical.init() process implementation. Expects to receive as parameters:
int	solve (lua_State *L)
	The analytical.solve() process implementation.

Additional Inherited Members
Protected Member Functions inherited from GmProcess
void	registerFunctions (LuaTable &table, typename GmProcessMethodRedirector< T >::MethodRegistry *methods, bool noProgressStats=false)
QStringList	buildFunctionList (typename GmProcessMethodRedirector< T >::MethodRegistry *methods) const
Protected Member Functions inherited from GmPluginObject
virtual const GmLogCategory &	logger () const
GmSimulationData *	simulationData () const

Detailed Description

Basic class for the analytical process plugin object.

Member Function Documentation

functionList()

virtual QStringList GmpAnalyticalProcess::functionList ( ) const

inlinevirtual

Implements GmProcess.

init()

int GmpAnalyticalProcess::init ( lua_State * L )

private

The analytical.init() process implementation. Expects to receive as parameters:

• The 3D mesh with the pressure and/or temperature data (name or mesh object). Can be a simple node mesh (point cloud).
• The 3D result mesh (name or mesh object) for storing displacmentes, stresses and strains. Can also be a simple node mesh (point cloud).
• A table with options, including sea floor information and attribute identifications. Returns a "solver" object that can be used to execute the calculations.

loadFunctions()

virtual void GmpAnalyticalProcess::loadFunctions ( LuaTable & table )

inlinevirtual

Implements GmProcess.

pluginName()

virtual const char * GmpAnalyticalProcess::pluginName ( ) const

inlinevirtual

Implements GmPluginObject.

pluginType()

virtual const char * GmpAnalyticalProcess::pluginType ( ) const

inlinevirtual

Implements GmPluginObject.

---

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

• inc/gmpAnalyticalProcess.h
• src/gmpAnalyticalProcess.cpp