icoco package

Submodules

• icoco.exception module
  • WrongContext
    • WrongContext.__init__()
  • WrongArgument
    • WrongArgument.__init__()
  • NotImplementedMethod
    • NotImplementedMethod.__init__()
• icoco.problem module
  • ICOCO_VERSION
  • ICOCO_MAJOR_VERSION
  • ICOCO_MINOR_VERSION
  • ValueType
    • ValueType.Double
    • ValueType.Int
    • ValueType.String
  • Problem
    • Problem.GetICoCoMajorVersion()
    • Problem.setDataFile()
    • Problem.setMPIComm()
    • Problem.initialize()
    • Problem.terminate()
    • Problem.presentTime()
    • Problem.computeTimeStep()
    • Problem.initTimeStep()
    • Problem.solveTimeStep()
    • Problem.validateTimeStep()
    • Problem.setStationaryMode()
    • Problem.getStationaryMode()
    • Problem.isStationary()
    • Problem.abortTimeStep()
    • Problem.resetTime()
    • Problem.iterateTimeStep()
    • Problem.save()
    • Problem.restore()
    • Problem.forget()
    • Problem.getInputFieldsNames()
    • Problem.getOutputFieldsNames()
    • Problem.getFieldType()
    • Problem.getMeshUnit()
    • Problem.getFieldUnit()
    • Problem.getInputMEDDoubleFieldTemplate()
    • Problem.setInputMEDDoubleField()
    • Problem.getOutputMEDDoubleField()
    • Problem.updateOutputMEDDoubleField()
    • Problem.getInputMEDIntFieldTemplate()
    • Problem.setInputMEDIntField()
    • Problem.getOutputMEDIntField()
    • Problem.updateOutputMEDIntField()
    • Problem.getInputMEDStringFieldTemplate()
    • Problem.setInputMEDStringField()
    • Problem.getOutputMEDStringField()
    • Problem.updateOutputMEDStringField()
    • Problem.getMEDCouplingMajorVersion()
    • Problem.isMEDCoupling64Bits()
    • Problem.getInputValuesNames()
    • Problem.getOutputValuesNames()
    • Problem.getValueType()
    • Problem.getValueUnit()
    • Problem.setInputDoubleValue()
    • Problem.getOutputDoubleValue()
    • Problem.setInputIntValue()
    • Problem.getOutputIntValue()
    • Problem.setInputStringValue()
    • Problem.getOutputStringValue()
• icoco.utils module
  • medcoupling
    • medcoupling.MEDCouplingField
    • medcoupling.MEDCouplingFieldDouble
    • medcoupling.MEDCouplingFieldInt
  • MPIComm
  • ICoCoMethods
    • ICoCoMethods.PROBLEM
    • ICoCoMethods.TIME_STEP
    • ICoCoMethods.RESTORE
    • ICoCoMethods.IO_FIELD
    • ICoCoMethods.IO_VALUE
    • ICoCoMethods.ALL
  • ICoCoMethodContext
    • ICoCoMethodContext.BEFORE_INITIALIZE
    • ICoCoMethodContext.ONLY_INSIDE_TIME_STEP_DEFINED
    • ICoCoMethodContext.ONLY_OUTSIDE_TIME_STEP_DEFINED
• icoco.version module
  • get_version()
  • get_version_int()
  • get_icoco_version()

Module contents

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:

https://github.com/cea-trust-platform/icoco-coupling

The package ICoCo (Interface for code coupling) encompasses all the classes and methods needed for the coupling of codes. See icoco.problem.Problem to start with.