Query properties
API to query idents and properties of a "Field Meta Model of Optimal Prognosis" (FMOP)
DYNARDO_FMOP_API fmop_error_t	FMOP_getModelIdents (const fmop_db_handle_t database, fmop_dataobject_types data_type, char **const fmop_idents, size_t num_idents)
	Returns all known FMOP identifier from the fmop_db_handle_t given. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getModelIdentsDim (const fmop_db_handle_t database, fmop_dataobject_types data_type, size_t *num_idents)
	Returns the total number of known FMOP identifiers from the fmop_db_handle_t given. More...

DYNARDO_FMOP_API const char *	FMOP_getModelIdent (const fmop_db_handle_t database, fmop_dataobject_types data_type, size_t num_ident)
	Returns the n-th known FMOP identifier from the fmop_db_handle_t given. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getModelParamIdents (const fmop_handle_t fmop, char **const param_idents, size_t num_params)
	Returns all active scalar inputer parameters for the fmop handle given. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getModelParamIdentsDim (const fmop_handle_t fmop, size_t *num_params)
	Returns the total number of active parameter identifiers from the fmop handle given. More...

DYNARDO_FMOP_API const char *	FMOP_getModelParamIdent (const fmop_handle_t fmop, size_t num_param)
	Returns the n-th active parameter identifier from the fmop handle given. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getParamLowerBounds (const fmop_handle_t fmop, double *lower_bounds)
	Returns lower bound values of input parameters used to train the FMOP, aka the lower bound values of Design of Experiment input parameters. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getParamUpperBounds (const fmop_handle_t fmop, double *upper_bounds)
	Returns upper bound values of input parameters used to train the FMOP, aka the upper bound values of Design of Experiment input parameters. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getModelTotalAvgFCoP (const fmop_handle_t fmop, double *fcop)
	Returns the total average Field Coefficient of Prognosis for the fmop handle given. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getModelAvgFCoP (const fmop_handle_t fmop, double *fcops)
	Returns the Field Coefficients of Prognosis per active scalar input parameter. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getModelDim (const fmop_handle_t fmop, size_t *num_mesh_items)
	Returns the size of the FCoP vector, aka the number of mesh items. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getDataDim (const fmop_db_handle_t database, fmop_dataobject_types data_type, size_t *num_mesh_items)
	Returns the size of the FCoP vector, aka the number of mesh items. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getDataPointIndices (fmop_handle_t fmop, unsigned int part_ids, unsigned int item_ids)
	Maps internal node/element numbering to the external scheme consisting of part and item ID. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getDataPointCoors (fmop_handle_t fmop, char axis, double *coors)
	Returns the cartesian data point coordinates for each data point. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getNumElementsAtNode (fmop_handle_t fmop, unsigned int node_idx, unsigned int *num_elements)
	Identifies the elements connected to a given node. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getElementsAtNode (fmop_handle_t fmop, unsigned int node_idx, unsigned int *elements)
	Identifies the elements connected to a given node. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_isNodePartOfBoundary (fmop_handle_t fmop, unsigned int node_idx, unsigned int *is_part_of_boundary)
	Identifies if the given node is on the surface. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getNumNodesAtElement (fmop_handle_t fmop, unsigned int element_idx, unsigned int *num_nodes)
	Identifies the nodes connected to a given element. More...

DYNARDO_FMOP_API fmop_error_t	FMOP_getNodesAtElement (fmop_handle_t fmop, unsigned int element_idx, unsigned int *nodes)
	Identifies the nodes connected to a given element. More...

DYNARDO_FMOP_API const char *	FMOP_getElementTypeIdent (fmop_handle_t fmop, unsigned int element_idx)
	Identifies the element type ident of a given element. More...

Detailed Description

Function Documentation

◆ FMOP_getDataDim()

DYNARDO_FMOP_API fmop_error_t FMOP_getDataDim	(	const fmop_db_handle_t	database,
		fmop_dataobject_types	data_type,
		size_t *	num_mesh_items
	)

Returns the size of the FCoP vector, aka the number of mesh items.

Parameters

[in]	database	A successfully initialized fmop_db_handle_t data object
[in]	data_type	The data type to be queried (node, element, scalar)
[in,out]	num_mesh_items	An already initialized scalar data object. Contains the size of the data vectors for the givvemn data type on return

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the num_mesh_items pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_initialize() returned fmop_model_success

◆ FMOP_getDataPointCoors()

DYNARDO_FMOP_API fmop_error_t FMOP_getDataPointCoors	(	fmop_handle_t	fmop,
		char	axis,
		double *	coors
	)

Returns the cartesian data point coordinates for each data point.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	axis	Controls coordinate output. The following integers are accepted: 0... asks for x-coordinates only 1... asks for y-coordinates only 2... asks for z-coordinates only 3... asks for x-, y- and z-coordinates
[in,out]	coors	An already initialized array of size $( 1 + \lfloor \frac{\mathit{axis}}{3} \rfloor ) * \mathit{num\_mesh\_items}$ . Call FMOP_getModelDim() to get num_mesh_items. On output contains the following coordinate values: finite element nodes for an FMOP of type fmop_node_data finite elements using their center coordinate in space for an FMOP of type fmop_element_data an FMOP of type fmop_scalar_data invokes an fmop_exception_occurred error Follows the scheme: $\mathit{coors} \lbrack k+ \mathit{axis} \bmod 3 \rbrack$ with k...internal mesh item ident, e.g. internal signal position, internal element number Call FMOP_getDataPointIndices() to map internal to external numbering scheme

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the axis parameter is out-of-bounds, or the coors pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

Warning: Calling this function for FMOP models of type fmop_element_data multiplies resource consumption!

◆ FMOP_getDataPointIndices()

DYNARDO_FMOP_API fmop_error_t FMOP_getDataPointIndices	(	fmop_handle_t	fmop,
		unsigned int *	part_ids,
		unsigned int *	item_ids
	)

Maps internal node/element numbering to the external scheme consisting of part and item ID.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	part_ids	Either an already initialized array of size num_mesh_items as returned by FMOP_getModelDim(), or a NULL pointer. Note, most of the meshes consists of a single part only, e.g. signals. If the argument is initialized, it contains the external part IDs on output. A NULL pointer otherwise external( internal[k] ) = PART_ID [k], item_id [k] k...mesh item, e.g. signal position, element number
[in,out]	item_ids	An already initialized array of size num_mesh_items as returned by FMOP_getModelDim(). On output contains the external node/element ID external( internal[k] ) = part_id [k], ITEM_ID [k] k...mesh item, e.g. signal position, element number

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the item_id pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getElementsAtNode()

DYNARDO_FMOP_API fmop_error_t FMOP_getElementsAtNode	(	fmop_handle_t	fmop,
		unsigned int	node_idx,
		unsigned int *	elements
	)

Identifies the elements connected to a given node.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	node_idx	the node index (0.. numNodes). This node index refers to the index in the FMOP data vectors.
[in,out]	elements	An already initialized array of size as returned by FMOP_getNumElementsAtNode(). On output contains the internal element ID that are connected to the given node.

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the item_id pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getElementTypeIdent()

DYNARDO_FMOP_API const char* FMOP_getElementTypeIdent	(	fmop_handle_t	fmop,
		unsigned int	element_idx
	)

Identifies the element type ident of a given element.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	element_idx	the element index (0.. numElements). This element index refers to the index in the FMOP data vectors.

Returns: On success the element type identifier at array position num_ident from the database given, othewise an empty string.

Note

Calling this function changes the error number to:

fmop_invalid_handle if the database or fmop_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the param_ident pointer does not hold a NULL pointer on input
fmop_settings_error if the value of num_param given is greater than, or equal to the size of the param_idents char* array []
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise. Call FMOP_getErrnoString() to get a human readable representation

Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelAvgFCoP()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelAvgFCoP	(	const fmop_handle_t	fmop,
		double *	fcops
	)

Returns the Field Coefficients of Prognosis per active scalar input parameter.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	fcops	An already initialized array of size num_params as returned by FMOP_getModelNumParams() On output contains the average Field Coefficient of Prognosis per active scalar input parameter Follows the scheme: fcops[i] (i..i'th active scalar input parameter).

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the fcops pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelDim()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelDim	(	const fmop_handle_t	fmop,
		size_t *	num_mesh_items
	)

Returns the size of the FCoP vector, aka the number of mesh items.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	num_mesh_items	An already initialized scalar data object. Contains the size of the FCoP vector on return

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the num_mesh_items pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelIdent()

DYNARDO_FMOP_API const char* FMOP_getModelIdent	(	const fmop_db_handle_t	database,
		fmop_dataobject_types	data_type,
		size_t	num_ident
	)

Returns the n-th known FMOP identifier from the fmop_db_handle_t given.

Parameters

[in]	database	A successfully initialized fmop_db_handle_t data object
[in]	data_type	The data type in question
[in]	num_ident	Defines the position in the fmop_idents char* array []. Notice that the first element has a position of 0

Returns: On succes the FMOP identifier at array position num_ident from the database given, otherwise an empty string. The returned string will be overwritten by this function at the next call and will be destroyed on program termination

Note

Calling this function changes the error number to:

fmop_invalid_handle if the database or fmop_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the fmop_idents pointer does not hold a NULL pointer on input
fmop_settings_error if the value of num_ident given is greater than, or equal to the size of the fmop_idents char* array []
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise. Call FMOP_getErrnoString() to get a human readable representation

Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelIdents()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelIdents	(	const fmop_db_handle_t	database,
		fmop_dataobject_types	data_type,
		char ***const	fmop_idents,
		size_t *	num_idents
	)

Returns all known FMOP identifier from the fmop_db_handle_t given.

Parameters

[in]	database	A successfully initialized fmop_db_handle_t data object
[in]	data_type	The data type in question
[in,out]	fmop_idents	On input *fmop_idents must point to NULL. On return contains all known FMOP identifier from the database given. Pointer ownership is up to the caller after return. Call FMOP_releaseIdents() at the end of life
[in,out]	num_idents	An already initialized scalar data object. Contains the number of FMOP idents, aka the size of the fmop_idents char* array []

Returns

fmop_invalid_handle if the database or fmop_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the fmop_idents pointer does not hold a NULL pointer on input
fmop_settings_error if the num_idents pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success; Many languages offers the possiblity to call functions from an external C-library, e.g. Java, python and Matlab. If you are running in some limitations due to our tripple pointer requirement, please use the wrapper functions FMOP_getModelIdentsDim() followed by FMOP_getModelIdent() to query known idents one by one

◆ FMOP_getModelIdentsDim()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelIdentsDim	(	const fmop_db_handle_t	database,
		fmop_dataobject_types	data_type,
		size_t *	num_idents
	)

Returns the total number of known FMOP identifiers from the fmop_db_handle_t given.

Parameters

[in]	database	A successfully initialized fmop_db_handle_t data object
[in]	data_type	The data type in question
[in,out]	num_idents	An already initialized scalar data object. Contains the number of FMOP idents, aka the size of the fmop_idents char* array []

Returns

fmop_invalid_handle if the database or fmop_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the num_idents pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelParamIdent()

DYNARDO_FMOP_API const char* FMOP_getModelParamIdent	(	const fmop_handle_t	fmop,
		size_t	num_param
	)

Returns the n-th active parameter identifier from the fmop handle given.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	num_param	Defines the position in the fmop_idents char* array []. Notice that the first element has a position of 0

Returns: On success the parameter identifier at array position num_ident from the database given, othewise an empty string. The returned string will be overwritten by this function at the next call and will be destroyed on program termination

Note

Calling this function changes the error number to:

fmop_invalid_handle if the database or fmop_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the param_ident pointer does not hold a NULL pointer on input
fmop_settings_error if the value of num_param given is greater than, or equal to the size of the param_idents char* array []
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise. Call FMOP_getErrnoString() to get a human readable representation

Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelParamIdents()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelParamIdents	(	const fmop_handle_t	fmop,
		char ***const	param_idents,
		size_t *	num_params
	)

Returns all active scalar inputer parameters for the fmop handle given.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[out]	param_idents	Requires a NULL pointer on input. On return contains all active scalar input parameters used in the fmop handle given. Pointer ownership is up to the caller after return. Call FMOP_releaseIdents() at the end of life
[in,out]	num_params	An already initialized scalar data object. Contains the number of active scalar input parameters used in the fmop handle given, aka the size of the param_idents char* array []

Returns

fmop_invalid_handle if the fmop or param_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the param_idents pointer does not hold a NULL pointer on input
fmop_settings_error if the num_params pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success; Many languages offers the possiblity to call functions from an external C-library, e.g. Java, python and Matlab. If you are running in some limitations due to our tripple pointer requirement, please use the wrapper functions FMOP_getModelParamIdentsDim() followed by FMOP_getModelParamIdent() to query known idents one by one

◆ FMOP_getModelParamIdentsDim()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelParamIdentsDim	(	const fmop_handle_t	fmop,
		size_t *	num_params
	)

Returns the total number of active parameter identifiers from the fmop handle given.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	num_params	An already initialized scalar data object. Contains the number of active scalar input parameters used in the fmop handle given, aka the size of the param_idents char* array []

Returns

fmop_invalid_handle if the fmop or param_idents arguments is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the num_params pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getModelTotalAvgFCoP()

DYNARDO_FMOP_API fmop_error_t FMOP_getModelTotalAvgFCoP	(	const fmop_handle_t	fmop,
		double *	fcop
	)

Returns the total average Field Coefficient of Prognosis for the fmop handle given.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	fcop	An already initialized scalar data object on input. On output contains the total average Field Coefficient of Prognosis

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the fcop pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getNodesAtElement()

DYNARDO_FMOP_API fmop_error_t FMOP_getNodesAtElement	(	fmop_handle_t	fmop,
		unsigned int	element_idx,
		unsigned int *	nodes
	)

Identifies the nodes connected to a given element.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	element_idx	the element index (0.. numElements). This element index refers to the index in the FMOP data vectors.
[in,out]	nodes	An already initialized array of size as returned by FMOP_getNumNodesAtElement(). On output contains the internal node ID that are connected to the given element.

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the item_id pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getNumElementsAtNode()

DYNARDO_FMOP_API fmop_error_t FMOP_getNumElementsAtNode	(	fmop_handle_t	fmop,
		unsigned int	node_idx,
		unsigned int *	num_elements
	)

Identifies the elements connected to a given node.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	node_idx	the node index (0.. numNodes). This node index refers to the index in the FMOP data vectors.
[in,out]	num_elements	a pointer to an unsigned integer number. On output it will contain the number of connected elements.

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the item_id pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getNumNodesAtElement()

DYNARDO_FMOP_API fmop_error_t FMOP_getNumNodesAtElement	(	fmop_handle_t	fmop,
		unsigned int	element_idx,
		unsigned int *	num_nodes
	)

Identifies the nodes connected to a given element.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	element_idx	the element index (0.. numElements). This element index refers to the index in the FMOP data vectors.
[in,out]	num_nodes	a pointer to an unsigned integer number. On output it will contain the number of connected nodes.

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the item_id pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getParamLowerBounds()

DYNARDO_FMOP_API fmop_error_t FMOP_getParamLowerBounds	(	const fmop_handle_t	fmop,
		double *	lower_bounds
	)

Returns lower bound values of input parameters used to train the FMOP, aka the lower bound values of Design of Experiment input parameters.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	lower_bounds	An already initialized array of size num_params as returned by FMOP_getModelParamIdents() On output contains the vector of lower bound values of all active scalar input parameters used to train the FMOP, e.g. lower_boundsj.

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the lower_bounds pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString() to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_getParamUpperBounds()

DYNARDO_FMOP_API fmop_error_t FMOP_getParamUpperBounds	(	const fmop_handle_t	fmop,
		double *	upper_bounds
	)

Returns upper bound values of input parameters used to train the FMOP, aka the upper bound values of Design of Experiment input parameters.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in,out]	upper_bounds	An already initialized array of size num_params as returned by FMOP_getModelParamIdents() On output contains the vector of upper bound values of all active scalar input parameters used to train the FMOP, e.g. upper_boundsj.

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the upper_bounds pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise.

Call FMOP_getErrnoString to get a human readable representation

Note: Assumes that FMOP_getModel() returned fmop_success

◆ FMOP_isNodePartOfBoundary()

DYNARDO_FMOP_API fmop_error_t FMOP_isNodePartOfBoundary	(	fmop_handle_t	fmop,
		unsigned int	node_idx,
		unsigned int *	is_part_of_boundary
	)

Identifies if the given node is on the surface.

Parameters

[in]	fmop	A successfully initialized fmop_handle_t data object
[in]	node_idx	the node index (0.. numNodes). This node index refers to the index in the FMOP data vectors.
[in,out]	is_part_of_boundary	a pointer to an unsigned integer number. On output it will contain 1 if the node is on the boundary 0 if the node is not on the boundary

Returns

fmop_invalid_handle if the fmop argument is a NULL pointer
fmop_license_error if a license error occurs, e.g. no license has been acquired so far or one tries to release a 3D mesh but acquired a SoS license for 1D meshes, e.g. signals, only
fmop_settings_error if the item_id pointer is a NULL pointer
fmop_exception_occurred if any other failure get invoked
fmop_success elsewise

Call FMOP_getErrnoString() to get a human readable representation

optiSLang C API of FMOPSolver Library 2025 R1

Query properties