cmiss_cellml::cellml_field_component_get Interface Reference

Private Member Functions
subroutine	cellml_field_component_get_c (CELLML, MODEL_INDEX, CELLML_FIELD_TYPE, VARIABLE_ID, COMPONENT_USER_NUMBER, ERR, ERROR,)
	Find the component ID in the given field for the variable defined by the given variable ID in the provided CellML environment. This generic routine will be used to map variable ID's in CellML models to components in the various fields defined in the CellML models defined for the provided CellML environment. More...
subroutine	cellml_field_component_get_vs (CELLML, MODEL_INDEX, CELLML_FIELD_TYPE, VARIABLE_ID, COMPONENT_USER_NUMBER, ERR, ERROR,)
	Find the component ID in the given field for the variable defined by the given variable ID in the provided CellML environment. This generic routine will be used to map variable ID's in CellML models to components in the various fields defined in the CellML models defined for the provided CellML environment. More...

Detailed Description

Definition at line 148 of file cmiss_cellml.f90.

Member Function/Subroutine Documentation

subroutine cmiss_cellml::cellml_field_component_get::cellml_field_component_get_c ( type(cellml_type), pointer  CELLML, integer(intg), intent(in)  MODEL_INDEX, integer(intg), intent(in)  CELLML_FIELD_TYPE, character(len=*), intent(in)  VARIABLE_ID, integer(intg), intent(out)  COMPONENT_USER_NUMBER, integer(intg), intent(out)  ERR, type(varying_string), intent(out)  ERROR  )

private

Find the component ID in the given field for the variable defined by the given variable ID in the provided CellML environment. This generic routine will be used to map variable ID's in CellML models to components in the various fields defined in the CellML models defined for the provided CellML environment.

• may need to also provide a FIELD_VARIABLE_NUMBER (always 1?) for completeness
• is the model ID also needed?
• because the CellML fields should all be set up to allow direct use in the CellML code, the component number matches the index of the given variable in its associated array in the CellML generated code.

Parameters

	cellml	The CellML environment object from which to get the field component.
[in]	model_index	The index of the CellML model to map from.
[in]	cellml_field_type	The type of CellML field type to get the component for.

See also

CMISS_CELLML::FieldTypes,CMISS_CELLML

Parameters

[in]	variable_id	The ID of the model variable which needs to be located in the provided field.
[out]	component_user_number	On return, the field component for the model variable defined by the given ID.
[out]	err	The error code.
[out]	error	The error string.

Definition at line 3423 of file cmiss_cellml.f90.

subroutine cmiss_cellml::cellml_field_component_get::cellml_field_component_get_vs ( type(cellml_type), pointer  CELLML, integer(intg), intent(in)  MODEL_INDEX, integer(intg), intent(in)  CELLML_FIELD_TYPE, type(varying_string), intent(in)  VARIABLE_ID, integer(intg), intent(out)  COMPONENT_USER_NUMBER, integer(intg), intent(out)  ERR, type(varying_string), intent(out)  ERROR  )

private

Find the component ID in the given field for the variable defined by the given variable ID in the provided CellML environment. This generic routine will be used to map variable ID's in CellML models to components in the various fields defined in the CellML models defined for the provided CellML environment.

• may need to also provide a FIELD_VARIABLE_NUMBER (always 1?) for completeness
• is the model ID also needed?

Parameters

	cellml	The CellML environment object from which to get the field component.
[in]	model_index	The index of the CellML model to map from.
[in]	cellml_field_type	The type of CellML field type to get the component for.

See also

CMISS_CELLML::FieldTypes,CMISS_CELLML

Parameters

[in]	variable_id	The ID of the model variable which needs to be located in the provided field.
[out]	component_user_number	On return, the field component for the model variable defined by the given ID.
[out]	err	The error code.
[out]	error	The error string.

Definition at line 3479 of file cmiss_cellml.f90.