icoco.utils module

ICoCo file common to several codes Version 2 – 02/2021

WARNING: this file is part of the official ICoCo API and should not be modified. The official version can be found at the following URL:

class icoco.utils.medcoupling[source]

Bases: object

dummy class for type hinting

Methods

`MEDCouplingField`()	dummy class for MEDCouplingField type hinting
`MEDCouplingFieldDouble`()	dummy class for MEDCouplingFieldDouble type hinting
`MEDCouplingFieldInt`()	dummy class for MEDCouplingFieldInt type hinting

class MEDCouplingField[source]

dummy class for MEDCouplingField type hinting

class MEDCouplingFieldDouble[source]

Bases: object

dummy class for MEDCouplingFieldDouble type hinting

class MEDCouplingFieldInt[source]

Bases: object

dummy class for MEDCouplingFieldInt type hinting

class icoco.utils.MPIComm[source]

Bases: object

Basic class for type hinting when mi4py is not available

class icoco.utils.ICoCoMethods[source]

Bases: object

Namespace to list all ICoCo methods.

PROBLEM = ['setDataFile', 'setMPIComm', 'initialize', 'terminate']: ICoco methods of section Problem

TIME_STEP = ['presentTime', 'computeTimeStep', 'initTimeStep', 'solveTimeStep', 'validateTimeStep', 'setStationaryMode', 'getStationaryMode', 'isStationary', 'abortTimeStep', 'resetTime', 'iterateTimeStep']: ICoco methods of section TimeStepManagement

RESTORE = ['save', 'restore', 'forget']: ICoco methods of section Restorable

IO_FIELD = ['getInputFieldsNames', 'getOutputFieldsNames', 'getFieldType', 'getMeshUnit', 'getFieldUnit', 'getInputMEDDoubleFieldTemplate', 'setInputMEDDoubleField', 'getOutputMEDDoubleField', 'updateOutputMEDDoubleField', 'getInputMEDIntFieldTemplate', 'setInputMEDIntField', 'getOutputMEDIntField', 'updateOutputMEDIntField', 'getInputMEDStringFieldTemplate', 'setInputMEDStringField', 'getOutputMEDStringField', 'updateOutputMEDStringField', 'getMEDCouplingMajorVersion', 'isMEDCoupling64Bits']: ICoco methods of section Field I/O

IO_VALUE = ['getInputValuesNames', 'getOutputValuesNames', 'getValueType', 'getValueUnit', 'setInputDoubleValue', 'getOutputDoubleValue', 'setInputIntValue', 'getOutputIntValue', 'setInputStringValue', 'getOutputStringValue']: ICoco methods of section Scalar values I/O

ALL = ['GetICoCoMajorVersion', 'setDataFile', 'setMPIComm', 'initialize', 'terminate', 'presentTime', 'computeTimeStep', 'initTimeStep', 'solveTimeStep', 'validateTimeStep', 'setStationaryMode', 'getStationaryMode', 'isStationary', 'abortTimeStep', 'resetTime', 'iterateTimeStep', 'save', 'restore', 'forget', 'getInputFieldsNames', 'getOutputFieldsNames', 'getFieldType', 'getMeshUnit', 'getFieldUnit', 'getInputMEDDoubleFieldTemplate', 'setInputMEDDoubleField', 'getOutputMEDDoubleField', 'updateOutputMEDDoubleField', 'getInputMEDIntFieldTemplate', 'setInputMEDIntField', 'getOutputMEDIntField', 'updateOutputMEDIntField', 'getInputMEDStringFieldTemplate', 'setInputMEDStringField', 'getOutputMEDStringField', 'updateOutputMEDStringField', 'getMEDCouplingMajorVersion', 'isMEDCoupling64Bits', 'getInputValuesNames', 'getOutputValuesNames', 'getValueType', 'getValueUnit', 'setInputDoubleValue', 'getOutputDoubleValue', 'setInputIntValue', 'getOutputIntValue', 'setInputStringValue', 'getOutputStringValue']: All ICoCo methods

class icoco.utils.ICoCoMethodContext[source]

Namespace to list all context restrictions for ICoCo methods.

BEFORE_INITIALIZE = ['setDataFile', 'setMPIComm', 'initialize']: Methods which must be called BEFORE initialize.

ONLY_INSIDE_TIME_STEP_DEFINED = ['solveTimeStep', 'iterateTimeStep', 'validateTimeStep', 'abortTimeStep']: Methods which must be called inside TIME_STEP_DEFINED context.

ONLY_OUTSIDE_TIME_STEP_DEFINED = ['terminate', 'computeTimeStep', 'initTimeStep', 'setStationaryMode', 'isStationary', 'resetTime', 'save', 'restore']: Methods which must be called outside TIME_STEP_DEFINED context.