cta_model_factory.h File Reference

Go to the source code of this file.

Functions
CTAEXPORT int	CTA_ModelFactory_New (const char *fName, CTA_ModelClass *modelClass)
	Create a COSTA modell class from XML input file (load from methods from dynamic load library).
CTAEXPORT CTA_ModelClass	CTAI_XML_CreateModelClass (xmlNode *cur_node)
	Create a COSTA modell class from XML (load from methods from dynamic load library).
CTAEXPORT int	CTA_Model_DefineClass (const char *name, const CTA_Func h_func[CTA_MODEL_NUMFUNC], CTA_ModelClass *hmodcl)
	Define a new class (=implementation) of a COSTA model component.
const char *	CTAI_ModelFac_GetImplements (CTA_ModelClass hmodcl)
int	CTAI_ModelFac_GetParallelData (CTA_ModelClass hmodcl, char **implements, char **parallel_type, char **spawn_workers, char **nproc, char **ntimes, char **dumProcs)
int	CTAI_ModelFac_GetBlock (CTA_ModelClass hmodcl, CTA_Model hmodel)
int	CTAI_ModelFac_GetBarrierData (CTA_ModelClass hmodcl, char **flag_barrier, double *t_step)
int	CTAI_ModelFac_AddModelInstance (CTA_ModelClass hmodcl, CTA_Model hmodel)
int	CTAI_ModelFac_SetBlock (CTA_ModelClass hmodcl, CTA_Model hmodel)
int	CTAI_ModelFac_TimeStepAllModels (CTA_ModelClass hmodcl, CTA_Function *function, double tstart, double tstop)

---

Function Documentation

CTAEXPORT int CTA_Model_DefineClass	(	const char *	name,
		const CTA_Func	h_func[CTA_MODEL_NUMFUNC],
		CTA_ModelClass *	hmodcl
	)

Define a new class (=implementation) of a COSTA model component.

Parameters:

	name	I name of the new model class
	h_func	I COSTA function handles for functions that implement class, missing functions must have value CTA_NULL
	hmodcl	O receives handle of new model class

Returns:

error status: CTA_OK if successful

CTAEXPORT int CTA_ModelFactory_New	(	const char *	fName,
		CTA_ModelClass *	modelClass
	)

Create a COSTA modell class from XML input file (load from methods from dynamic load library).

Parameters:

	fName	I XML-configuration file
	modelClass	O Class of new model Factory

Returns:

Model class handle

int CTAI_ModelFac_AddModelInstance	(	CTA_ModelClass	hmodcl,
		CTA_Model	hmodel
	)

int CTAI_ModelFac_GetBarrierData	(	CTA_ModelClass	hmodcl,
		char **	flag_barrier,
		double *	t_step
	)

int CTAI_ModelFac_GetBlock	(	CTA_ModelClass	hmodcl,
		CTA_Model	hmodel
	)

const char* CTAI_ModelFac_GetImplements

(

CTA_ModelClass

hmodcl

)

int CTAI_ModelFac_GetParallelData	(	CTA_ModelClass	hmodcl,
		char **	implements,
		char **	parallel_type,
		char **	spawn_workers,
		char **	nproc,
		char **	ntimes,
		char **	dumProcs
	)

int CTAI_ModelFac_SetBlock	(	CTA_ModelClass	hmodcl,
		CTA_Model	hmodel
	)

int CTAI_ModelFac_TimeStepAllModels	(	CTA_ModelClass	hmodcl,
		CTA_Function *	function,
		double	tstart,
		double	tstop
	)

CTAEXPORT CTA_ModelClass CTAI_XML_CreateModelClass

(

xmlNode *

cur_node

)

Create a COSTA modell class from XML (load from methods from dynamic load library).

Parameters:

cur_node

I Current XML node

Returns:

Handle to create or CTA_NULL in case of an error.