OpenCMISS-Iron Internal API Documentation
Modules
Here is a list of all modules:
[detail level 123456]
 ANALYTIC_ANALYSIS_ROUTINES::ErrorTypesErrors definition type parameters
 BASE_ROUTINES::OutputTypeOutput type parameter
 BASE_ROUTINES::FileUnitsFile unit parameters
 BASE_ROUTINES::DiagnosticTypesDiganostic type parameters
 BASE_ROUTINES::TimingTypesTiming type parameters
 BASIS_ROUTINES::BasisTypesBasis definition type parameters
 BASIS_ROUTINES::InterpolationSpecificationsInterpolation specification parameters
 BASIS_ROUTINES::InterpolationTypesInterpolation type parameters for a Xi direction
 BASIS_ROUTINES::InterpolationOrderInterpolation order for a Xi direction
 BASIS_ROUTINES::QuadratureSchemesQuadrature scheme parameters. NOTE: Quadratures schemes have not been implemented yet. For now you should just use the BASIS_DEFAULT_QUADRATURE_SCHEME
 BASIS_ROUTINES::QuadratureTypesQuadrature type parameters
 BASIS_ROUTINES::XiCollapseXi collapse parameters
 BOUNDARY_CONDITIONS_ROUTINES::DOFTypesDOF type for boundary conditions
 BOUNDARY_CONDITIONS_ROUTINES::BoundaryConditionsBoundary conditions types. These may be specific to a particular equation type and the solver routines should not need to use these
 BOUNDARY_CONDITIONS_ROUTINES::BoundaryConditionsStorage type for matrices used by boundary conditions
 CMISS::ErrorHandlingModesError handling mode parameters
 CMISS_CELLML::FieldTypesCellML field parameter types
 CMISS_CELLML::FieldMappingTypesCellML field parameter types
 CMISS_CELLML::ModelsFieldTypesCellML field parameter types
 CmissPetsc::PetscMatInsertModeTypes of PETSc matrix insert modes
 CmissPetsc::PetscKSPTypesTypes of PETSc KSP (Krylov Subspace) solvers
 CmissPetsc::PetscMatOptionTypes of matrix options for PETSc matrices
 CONSTANTS::MathPhysicalConstants
 CONSTANTS::NumericalConstants
 CONSTANTS::DataTypesData type parameters for base data types
 CONSTANTS::EndianTypesEndian type parameters
 CONSTANTS::CharacterFormatTypesBit format types for characters
 CONSTANTS::IntegerTypesBit format types for integers
 CONSTANTS::RealFormatTypesBit format types for reals
 CONSTANTS::ComputerSystemTypesComputer system type parameters
 CONSTANTS::OperatingSystemTypesOperating system type parameters
 CONSTANTS::LibraryTypesLibrary type identifiers
 CONSTANTS::PartialDerivativeConstantsPartial derivative constant identifiers
 CONSTANTS::GlobalDerivativeConstantsGlobal derivative constant identifiers
 CONSTANTS::PhysicalDerivativeConstantsPhysical derivative constant identifiers
 CONTROL_LOOP_ROUTINES::ControlLoopIdentifiersThe control loop identification parameters
 CONTROL_LOOP_ROUTINES::OutputTypesThe types of output for a control loop
 COORDINATE_ROUTINES::CoordinateSystemTypes
 COORDINATE_ROUTINES::RadialInterpolationsThe type of radial interpolation for polar coordinate systems
 COORDINATE_ROUTINES::JacobianTypeThe type of Jacobian to return when coordinate metrics are calculated
 DATA_POINT_PROJECTION_ROUTINES::DataProjectionTypesDatapoint projection definition type parameters
 DATA_POINT_PROJECTION_ROUTINES::DataProjectionExitTagsDatapoint projection exit tags
 DISTRIBUTED_MATRIX_VECTOR::LibraryTypesDistributed matrix-vector library types
 DISTRIBUTED_MATRIX_VECTOR::DataTypesDistributed matrix-vector data types
 DISTRIBUTED_MATRIX_VECTOR::StorageTypesDistributed matrix-vector storage type parameters
 DISTRIBUTED_MATRIX_VECTOR::GhostingTypesDistributed matrix-vector ghosting types
 DOMAIN_MAPPINGS::DomainType
 EQUATIONS_MATRICES_ROUTINES::EquationsMatrixStructureTypesEquations matrices structure (sparsity) types
 EQUATIONS_MATRICES_ROUTINES::LumpingTypesEquations matrix lumping types
 EQUATIONS_MATRICES_ROUTINES::EquationsMatricesSparsityTypesEquations matrices sparsity types
 EQUATIONS_MATRICES_ROUTINES::SelectMatricesTypesThe types of selection available for the equations matrices
 EQUATIONS_MATRICES_ROUTINES:JacobianCalculationTypesJacobian calculation types
 EQUATIONS_ROUTINES::OutputTypesThe equations output types
 EQUATIONS_ROUTINES::SparsityTypesEquations matrices sparsity types
 EQUATIONS_ROUTINES::LumpingTypesEquations matrices lumping types
 EQUATIONS_SET_CONSTANTS::SetupTypesSetup type parameters
 EQUATIONS_SET_CONSTANTS::SetupActionTypesSetup action type parameters
 EQUATIONS_SET_CONSTANTS::SolutionMethodsThe solution method parameters
 EQUATIONS_SET_CONSTANTS::LinearityTypesThe equations linearity types
 EQUATIONS_SET_CONSTANTS::TimeDependenceTypesThe equations time dependence type parameters
 EQUATIONS_SET_CONSTANTS::DerivedTypesDerived field values to calculate
 EQUATIONS_SET_CONSTANTS::TensorEvaluateTypesType of tensor to evaluate from an EquationsSet
 EQUATIONS_SET_CONSTANTS:DynamicMatrixTypesType of matrix in a dynamic equations set
 EQUATIONS_SET_CONSTANTS::AnalyticFunctionTypesThe analytic function types
 FINITE_ELASTICITY_ROUTINES::AnalyticParamIndicesIndices for EQUATIONS_SET_ANALYTIC_TYPEANALYTIC_USER_PARAMS
 HISTORY_ROUTINES::FileFormatTypesThe types of a file format for a history file
 INPUT_OUTPUT::MatrixNameIndexFormatOutput type parameter
 INTERFACE_CONDITIONS_CONSTANTS::MethodsInterface condition methods
 INTERFACE_CONDITIONS_CONSTANTS::OperatorsInterface condition operators
 INTERFACE_CONDITIONS_CONSTANTS::LinearityTypesThe interface condition linearity types
 INTERFACE_CONDITIONS_CONSTANTS::TimeDependenceTypesThe interface condition time dependence type parameters
 INTERFACE_CONDITIONS_CONSTANTS::IntegrationTypeInterface condition IntegrationType
 INTERFACE_EQUATIONS_ROUTINES::OutputTypesThe interface equations output types
 INTERFACE_EQUATIONS_ROUTINES::SparsityTypesInterface equations matrices sparsity types
 INTERFACE_MATRICES_ROUTINES::InterfaceMatricesTimeDependenceTypesInterface matrices time dependency types
 KINDS::IntegerKindsKind parameters for integer data types
 KINDS::RealKindsKind parameters for real data types
 KINDS::ComplexKindsKind parameters for complex data types
 LISTS::DataTypeData type parameters for a list
 LISTS::SortingOrderSorting order parameters for a list
 LISTS::SortingMethodSorting method parameters for a list
 MATRIX_VECTOR::DataTypesMatrix vector data types
 MATRIX_VECTOR::StorageTypesMatrix-vector storage type parameters
 OPENCMISS::Kinds::ConstantsKind constants
 OPENCMISS::DiagnosticAndTiming::ConstantsDiagnostic and Timing constants
 OPENCMISS::Basis::ConstantsBasis function constants
 OPENCMISS::BoundaryConditions::ConstantsBoundary conditions constants
 OpenCMISS::Iron::cmfe_::ConstantsCMISS constants
 OPENCMISS::CellML::ConstantsCellML constants
 OPENCMISS::ConstantsOpeCMISS constants
 OPENCMISS::ControlLoop::ConstantsControl loops constants
 OPENCMISS::Coordinate::ConstantsCoordinate constants
 OPENCMISS::DataProjection::ConstantsDataProjection constants
 OPENCMISS::Equations::ConstantsEquations constants
 PROBLEM_CONSTANTS::SetupTypesSetup type parameters
 PROBLEM_CONSTANTS::SetupActionTypesSetup action type parameters
 PROBLEM_CONSTANTS::ControlLoopTypesControl loop type parameters
 PROBLEM_CONSTANTS::LinearityTypesSetup type parameters
 PROBLEM_CONSTANTS::EquationsLinearityTypesThe solver equations linearity types
 PROBLEM_CONSTANTS::EquationsTimeDependenceTypesThe solver equations time dependence types
 SOLVER_MAPPING::EquationsMatrixTypesEquations matrix types
 SOLVER_MAPPING::EquationsTypesEquations Matrix types
 SOLVER_MATRICES_ROUTINES::SelectMatricesTypesThe types of selection available for the solver matrices
 SOLVER_ROUTINES::SolverTypesThe types of solver
 SOLVER_ROUTINES::SolverLibrariesThe types of solver libraries
 SOLVER_ROUTINES::LinearSolverTypesThe types of linear solvers
 SOLVER_ROUTINES::DirectLinearSolverTypesThe types of direct linear solvers
 SOLVER_ROUTINES::IterativeLinearSolverTypesThe types of iterative linear solvers
 SOLVER_ROUTINES::IterativePreconditionerTypesThe types of iterative preconditioners
 SOLVER_ROUTINES::NonlinearSolverTypesThe types of nonlinear solvers
 SOLVER_ROUTINES::QuasiNewtonSolverTypesThe types of nonlinear Quasi-Newton solvers
 SOLVER_ROUTINES::QuasiNewtonTypesThe nonlinear Quasi-Newton types
 SOLVER_ROUTINES::QuasiNewtonLineSearchTypesThe types line search techniques for Quasi-Newton line search nonlinear solvers
 SOLVER_ROUTINES::QuasiNewtonRestartTypesThe nonlinear Quasi-Newton restart types
 SOLVER_ROUTINES::QuasiNewtonScaleTypesThe nonlinear Quasi-Newton scale types
 SOLVER_ROUTINES::NewtonSolverTypesThe types of nonlinear Newton solvers
 SOLVER_ROUTINES::NewtonLineSearchTypesThe types line search techniques for Newton line search nonlinear solvers
 SOLVER_ROUTINES::JacobianCalculationTypesThe Jacobian calculation types for a nonlinear solver
 SOLVER_ROUTINES::NewtonConvergenceTestTypesThe convergence test types for a nonlinear solver
 SOLVER_ROUTINES::DynamicOrderTypesThe order types for a dynamic solver
 SOLVER_ROUTINES::DynamicLinearityTypesThe time linearity types for a dynamic solver
 SOLVER_ROUTINES::DynamicDegreeTypesThe time interpolation polynomial degree types for a dynamic solver
 SOLVER_ROUTINES::DynamicSchemeTypesThe types of dynamic solver scheme
 SOLVER_ROUTINES::DAETypesThe type of differential-algebraic equation
 SOLVER_ROUTINES::DAESolverTypesThe differential-algebraic equation solver types for a differential-algebraic equation solver
 SOLVER_ROUTINES::EulerDAESolverTypesThe Euler solver types for a differential-algebriac equation solver
 SOLVER_ROUTINES::SolutionInitialiseTypesThe types of solution initialisation
 SOLVER_ROUTINES::OutputTypesThe types of output
 SOLVER_ROUTINES::SparsityTypesThe types of sparse solver matrices
 TIMER::TimerTypeTimer type parameter
 TREES::TreeNodeColourTypesThe colour of the tree nodes
 TREES::TreeNodeInsertStatusThe insert status for tree nodes
 TREES::TreeInsertTypesThe insert type for a tree