API references

Modules

cosapp.core.numerics.basics

cosapp.core.numerics.boundary

cosapp.core.numerics.enum

cosapp.core.numerics.residues

cosapp.core.numerics.solve.jacobian

cosapp.core.numerics.solve.linear_solver

cosapp.core.numerics.solve.non_linear_solver

cosapp.core.numerics.solve.root(fun, x0[, ...])

cosapp.core.signal.signal

Module defining the Signal class.

cosapp.core.signal.slot

Module defining the Slot class.

cosapp.core.config

Configuration of CoSApp.

cosapp.core.eval_str

Module handling the execution of code provided as string by the user.

cosapp.core.module

Basic class handling model tree structure.

cosapp.core.time

cosapp.patterns.singleton

cosapp.patterns.observer

cosapp.patterns.visitor

cosapp.ports.port

cosapp.ports.enum

cosapp.ports.connectors

Classes connecting Port of foreign System to transfer variable values.

cosapp.ports.exceptions

Port exceptions

cosapp.ports.variable

This module define the basic class encapsulating a variable attributes.

cosapp.ports.mode_variable

This module defines the basic class encapsulating mode variable attributes.

cosapp.ports.units

Classes and functions to support unit conversion.

cosapp.systems.system

Basic classes handling model resolution, system connections and conversion between level of modelings.

cosapp.systems.systemfamily

cosapp.systems.processsystem

cosapp.systems.externalsystem

cosapp.systems.metamodels

System tuned to support meta-models.

cosapp.systems.batch

cosapp.multimode.event

cosapp.multimode.zeroCrossing

cosapp.multimode.discreteStepper

Event handling and discrete stepping

cosapp.drivers.driver

Classes driving simulation on CoSApp System.

cosapp.drivers.time.base

cosapp.drivers.time.euler

cosapp.drivers.time.runge_kutta

cosapp.drivers.time.crank_nicolson

cosapp.drivers.time.bdf

cosapp.drivers.time.scenario

cosapp.drivers.time.utils

cosapp.drivers.abstractsetofcases

cosapp.drivers.abstractsolver

cosapp.drivers.fixedpoint

cosapp.drivers.influence

cosapp.drivers.iterativecase

cosapp.drivers.lineardoe

cosapp.drivers.metasystembuilder

cosapp.drivers.montecarlo

cosapp.drivers.nonlinearsolver

cosapp.drivers.optimizer

Driver for System optimization.

cosapp.drivers.optionaldriver

cosapp.drivers.runonce

cosapp.drivers.runsinglecase

cosapp.drivers.validitycheck

cosapp.drivers.utils

cosapp.recorders.recorder

Base class for recording data.

cosapp.recorders.dataframe_recorder

Recorder in pandas.DataFrame.

cosapp.recorders.dsv_recorder

Recorder to Delimited Separated Value format file.

cosapp.tools.fmu.exporter

Export a System as FMU.

cosapp.tools.problem_viewer.problem_viewer

cosapp.tools.problem_viewer.webview

cosapp.tools.help

Tool to print the description of a CoSApp object.

cosapp.tools.trigger

Utility classes for executing CoSApp simulation following file events.

cosapp.tools.module_parser.parseModule

cosapp.utils.distributions.distribution

Basic class to define a variable distribution.

cosapp.utils.distributions.normal

Basic class to define a variable distribution.

cosapp.utils.distributions.triangular

Class defining a triangular distribution.

cosapp.utils.distributions.uniform

Class defining an uniform distribution.

cosapp.utils.swap_system(old_system, new_system)

Replace old_system by new_system.

cosapp.utils.context

cosapp.utils.helpers

Various small helper functions.

cosapp.utils.json

cosapp.utils.logging

Customized log handler for CoSApp simulation.

cosapp.utils.naming

cosapp.utils.options_dictionary

Define the OptionsDictionary class.

cosapp.utils.parsing

cosapp.utils.pull_variables

cosapp.utils.find_variables

cosapp.utils.validate

Inheritance

  • cosapp.core.numerics

classDiagram class ABC class AbstractBoundaryImpl link AbstractBoundaryImpl "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.AbstractBoundaryImpl" "Abstract Boundary class to manage methods specific to Boundary type." ABC <|-- AbstractBoundaryImpl class AbstractResidue link AbstractResidue "./_autosummary/cosapp.core.numerics.residues.html#cosapp.core.numerics.residues.AbstractResidue" "Abstract class defining residue for solvers." class AbstractTimeUnknown link AbstractTimeUnknown "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.AbstractTimeUnknown" "AbstractTimeUnknown" ABC <|-- AbstractTimeUnknown class AttrRef link AttrRef "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.AttrRef" "Attribute Reference for scalar object." class BaseProblem link BaseProblem "./_autosummary/cosapp.core.numerics.basics.html#cosapp.core.numerics.basics.BaseProblem" "Container object for unknowns and equations." ABC <|-- BaseProblem class Boundary link Boundary "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.Boundary" "Numerical solver boundary." class DeferredResidue link DeferredResidue "./_autosummary/cosapp.core.numerics.residues.html#cosapp.core.numerics.residues.DeferredResidue" "Class representing a residue whose left-hand side evaluation is deferred." class Enum class GenericBoundaryImpl link GenericBoundaryImpl "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.GenericBoundaryImpl" "Class handling undefined Boundary." AbstractBoundaryImpl <|-- GenericBoundaryImpl class MaskedAttrRef link MaskedAttrRef "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.MaskedAttrRef" "Masked Attribute Reference for MutableSequence-like object." AttrRef <|-- MaskedAttrRef class MaskedVarInfo link MaskedVarInfo "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.MaskedVarInfo" "MaskedVarInfo(basename, selector, mask)" class MathematicalProblem link MathematicalProblem "./_autosummary/cosapp.core.numerics.basics.html#cosapp.core.numerics.basics.MathematicalProblem" "Container object for unknowns and equations." BaseProblem <|-- MathematicalProblem class MutableSeqBoundaryImpl link MutableSeqBoundaryImpl "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.MutableSeqBoundaryImpl" "Specific methods for MutableSequence-like Boundary." AbstractBoundaryImpl <|-- MutableSeqBoundaryImpl class NonLinearMethods link NonLinearMethods "./_autosummary/cosapp.core.numerics.enum.html#cosapp.core.numerics.enum.NonLinearMethods" "Enumeration of non-linear algorithm available." Enum <|-- NonLinearMethods class NumpyBoundaryImpl link NumpyBoundaryImpl "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.NumpyBoundaryImpl" "Specific methods for numpy.ndarray Boundary." AbstractBoundaryImpl <|-- NumpyBoundaryImpl class NumpyMaskedAttrRef link NumpyMaskedAttrRef "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.NumpyMaskedAttrRef" "Masked Attribute Reference for numpy arrays." AttrRef <|-- NumpyMaskedAttrRef class Residue link Residue "./_autosummary/cosapp.core.numerics.residues.html#cosapp.core.numerics.residues.Residue" "Classical residue definition based on an equality equation" AbstractResidue <|-- Residue class ScalarBoundaryImpl link ScalarBoundaryImpl "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.ScalarBoundaryImpl" "Specific methods for Number Boundary." AbstractBoundaryImpl <|-- ScalarBoundaryImpl class SolverResults link SolverResults "./_autosummary/cosapp.core.numerics.basics.html#cosapp.core.numerics.basics.SolverResults" "Data class for solver solution" class TimeDerivative link TimeDerivative "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.TimeDerivative" "Explicit time derivative." Boundary <|-- TimeDerivative class TimeProblem link TimeProblem "./_autosummary/cosapp.core.numerics.basics.html#cosapp.core.numerics.basics.TimeProblem" "Container object for time-dependent variables." BaseProblem <|-- TimeProblem class TimeUnknown link TimeUnknown "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.TimeUnknown" "Time-dependent solver unknown." Boundary <|-- TimeUnknown AbstractTimeUnknown <|-- TimeUnknown class UndefinedBoundaryImpl link UndefinedBoundaryImpl "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.UndefinedBoundaryImpl" "Class handling undefined Boundary." AbstractBoundaryImpl <|-- UndefinedBoundaryImpl class Unknown link Unknown "./_autosummary/cosapp.core.numerics.boundary.html#cosapp.core.numerics.boundary.Unknown" "Numerical solver unknown." Boundary <|-- Unknown class WeakDeferredResidue link WeakDeferredResidue "./_autosummary/cosapp.core.numerics.basics.html#cosapp.core.numerics.basics.WeakDeferredResidue" "WeakDeferredResidue(deferred, weak)"

  • cosapp.drivers

classDiagram class ABC class AbstractSetOfCases link AbstractSetOfCases "./_autosummary/cosapp.drivers.abstractsetofcases.html#cosapp.drivers.abstractsetofcases.AbstractSetOfCases" "This driver builds a set of cases from a list" Driver <|-- AbstractSetOfCases class AbstractSolver link AbstractSolver "./_autosummary/cosapp.drivers.abstractsolver.html#cosapp.drivers.abstractsolver.AbstractSolver" "Solve a `System`" Driver <|-- AbstractSolver class AbstractTimeDriver link AbstractTimeDriver "./_autosummary/cosapp.drivers.time.base.html#cosapp.drivers.time.base.AbstractTimeDriver" "Generic implementation of a time driver with managed time step." Driver <|-- AbstractTimeDriver class BaseSolverBuilder link BaseSolverBuilder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.BaseSolverBuilder" "Base interface for numerical system building strategy used by `NonLinearSolver`." ABC <|-- BaseSolverBuilder class BaseSolverRecorder link BaseSolverRecorder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.BaseSolverRecorder" "Abstract interface for solver recorder" ABC <|-- BaseSolverRecorder class Component link Component "./_autosummary/cosapp.patterns.visitor.html#cosapp.patterns.visitor.Component" "Abstract Base Class for visited components" class CompositeSolverRecorder link CompositeSolverRecorder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.CompositeSolverRecorder" "Solver recorder specialization for solvers with sub-drivers." BaseSolverRecorder <|-- CompositeSolverRecorder class CrankNicolson link CrankNicolson "./_autosummary/cosapp.drivers.time.crank_nicolson.html#cosapp.drivers.time.crank_nicolson.CrankNicolson" "Second-order Crank-Nicolson implicit integrator." ImplicitTimeDriver <|-- CrankNicolson class Driver link Driver "./_autosummary/cosapp.drivers.driver.html#cosapp.drivers.driver.Driver" "Abstract base class for all systems drivers." Module <|-- Driver HasCompositeOptions <|-- Driver class EmptySolverRecorder link EmptySolverRecorder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.EmptySolverRecorder" "Specialization for solvers with no recorder." BaseSolverRecorder <|-- EmptySolverRecorder class EulerExplicit link EulerExplicit "./_autosummary/cosapp.drivers.time.euler.html#cosapp.drivers.time.euler.EulerExplicit" "EulerExplicit" AbstractTimeDriver <|-- EulerExplicit class EulerImplicit link EulerImplicit "./_autosummary/cosapp.drivers.time.euler.html#cosapp.drivers.time.euler.EulerImplicit" "EulerImplicit" ImplicitTimeDriver <|-- EulerImplicit class HasCompositeOptions link HasCompositeOptions "./_autosummary/cosapp.utils.options_dictionary.html#cosapp.utils.options_dictionary.HasCompositeOptions" "HasCompositeOptions" HasOptions <|-- HasCompositeOptions class HasOptions link HasOptions "./_autosummary/cosapp.utils.options_dictionary.html#cosapp.utils.options_dictionary.HasOptions" "Base class to handle options as `OptionsDictionary`." class ImplicitTimeDriver AbstractTimeDriver <|-- ImplicitTimeDriver class Influence link Influence "./_autosummary/cosapp.drivers.influence.html#cosapp.drivers.influence.Influence" "This driver evaluate the influence between inputs and outputs (floats only)" AbstractSetOfCases <|-- Influence class IterativeCase link IterativeCase "./_autosummary/cosapp.drivers.iterativecase.html#cosapp.drivers.iterativecase.IterativeCase" "Abstract interface to children cases for a :py:class:`~cosapp.drivers.abstractsolver.AbstractSolver`." RunOnce <|-- IterativeCase class LinearDoE link LinearDoE "./_autosummary/cosapp.drivers.lineardoe.html#cosapp.drivers.lineardoe.LinearDoE" "This driver builds a set of linear Doe" AbstractSetOfCases <|-- LinearDoE class LoggerContext link LoggerContext "./_autosummary/cosapp.utils.logging.html#cosapp.utils.logging.LoggerContext" "Interface for context object to connect to the logging system." class MetaSystemBuilder link MetaSystemBuilder "./_autosummary/cosapp.drivers.metasystembuilder.html#cosapp.drivers.metasystembuilder.MetaSystemBuilder" "MetaSystemBuilder" Driver <|-- MetaSystemBuilder class Module link Module "./_autosummary/cosapp.core.module.html#cosapp.core.module.Module" "A class to describe generic properties and functions of a component that can be single or" LoggerContext <|-- Module Component <|-- Module class MonteCarlo link MonteCarlo "./_autosummary/cosapp.drivers.montecarlo.html#cosapp.drivers.montecarlo.MonteCarlo" "This driver execute a MonteCarlo simulation on its system." AbstractSetOfCases <|-- MonteCarlo class MultipointSolverBuilder link MultipointSolverBuilder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.MultipointSolverBuilder" "System building strategy for solvers with one or more" BaseSolverBuilder <|-- MultipointSolverBuilder class NonLinearSolver link NonLinearSolver "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.NonLinearSolver" "Solve mathematical problem with algebraic variables." AbstractSolver <|-- NonLinearSolver class Optimizer link Optimizer "./_autosummary/cosapp.drivers.optimizer.html#cosapp.drivers.optimizer.Optimizer" "Driver running an optimization problem on its `System` owner." AbstractSolver <|-- Optimizer class OptionalDriver link OptionalDriver "./_autosummary/cosapp.drivers.optionaldriver.html#cosapp.drivers.optionaldriver.OptionalDriver" "Abstract class to be inherited by driver turn off during heavy computation." Driver <|-- OptionalDriver class RandomVariable link RandomVariable "./_autosummary/cosapp.drivers.montecarlo.html#cosapp.drivers.montecarlo.RandomVariable" "Class representing a random variable in a system of interest" class RunOnce link RunOnce "./_autosummary/cosapp.drivers.runonce.html#cosapp.drivers.runonce.RunOnce" "Driver running the model on its `System` owner." Driver <|-- RunOnce class RunSingleCase link RunSingleCase "./_autosummary/cosapp.drivers.runsinglecase.html#cosapp.drivers.runsinglecase.RunSingleCase" "Set new boundary conditions and equations on the system." IterativeCase <|-- RunSingleCase class RungeKutta link RungeKutta "./_autosummary/cosapp.drivers.time.runge_kutta.html#cosapp.drivers.time.runge_kutta.RungeKutta" "Implementation of a few Runge-Kutta methods for time integration." AbstractTimeDriver <|-- RungeKutta class SolverRecorderCallback link SolverRecorderCallback "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.SolverRecorderCallback" "Callback functor to monitor solver residues" class StandaloneSolverBuilder link StandaloneSolverBuilder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.StandaloneSolverBuilder" "System building strategy for solvers with no" BaseSolverBuilder <|-- StandaloneSolverBuilder class StandaloneSolverRecorder link StandaloneSolverRecorder "./_autosummary/cosapp.drivers.nonlinearsolver.html#cosapp.drivers.nonlinearsolver.StandaloneSolverRecorder" "Solver recorder specialization for solvers with no sub-drivers." BaseSolverRecorder <|-- StandaloneSolverRecorder class ValidityCheck link ValidityCheck "./_autosummary/cosapp.drivers.validitycheck.html#cosapp.drivers.validitycheck.ValidityCheck" "When executed, this driver reports in the log the validity status for all variables of the" OptionalDriver <|-- ValidityCheck

  • cosapp.ports

classDiagram class BasePort link BasePort "./_autosummary/cosapp.ports.port.html#cosapp.ports.port.BasePort" "Base class for ports, containers gathering variables." Component <|-- BasePort class Component link Component "./_autosummary/cosapp.patterns.visitor.html#cosapp.patterns.visitor.Component" "Abstract Base Class for visited components" class ExtensiblePort link ExtensiblePort "./_autosummary/cosapp.ports.port.html#cosapp.ports.port.ExtensiblePort" "Class describing ports with a varying number of variables." BasePort <|-- ExtensiblePort class ModeVarPort link ModeVarPort "./_autosummary/cosapp.ports.port.html#cosapp.ports.port.ModeVarPort" "Class used for the local storage of mode variables." BasePort <|-- ModeVarPort class Port link Port "./_autosummary/cosapp.ports.port.html#cosapp.ports.port.Port" "A `Port` is a container gathering variables tightly linked." BasePort <|-- Port

  • cosapp.ports.connectors

classDiagram class ABC class BaseConnector link BaseConnector "./_autosummary/cosapp.ports.connectors.html#cosapp.ports.connectors.BaseConnector" "This class connect two ports without enforcing that all port variables are connected." ABC <|-- BaseConnector class Connector link Connector "./_autosummary/cosapp.ports.connectors.html#cosapp.ports.connectors.Connector" "Shallow copy connector." BaseConnector <|-- Connector class ConnectorError link ConnectorError "./_autosummary/cosapp.ports.connectors.html#cosapp.ports.connectors.ConnectorError" "Raised if a connector cannot be created between two `Port`."

  • cosapp.recorders

classDiagram class ABC class BaseRecorder link BaseRecorder "./_autosummary/cosapp.recorders.recorder.html#cosapp.recorders.recorder.BaseRecorder" "Abstract base class for recorders." ABC <|-- BaseRecorder class DSVRecorder link DSVRecorder "./_autosummary/cosapp.recorders.dsv_recorder.html#cosapp.recorders.dsv_recorder.DSVRecorder" "Record data into Delimiter Separated Value file." BaseRecorder <|-- DSVRecorder class DataFrameRecorder link DataFrameRecorder "./_autosummary/cosapp.recorders.dataframe_recorder.html#cosapp.recorders.dataframe_recorder.DataFrameRecorder" "Record data into a pandas.DataFrame." BaseRecorder <|-- DataFrameRecorder class SpecialColumns link SpecialColumns "./_autosummary/cosapp.recorders.recorder.html#cosapp.recorders.recorder.SpecialColumns" "SpecialColumns(section, status, code, reference)"

  • cosapp.systems

classDiagram class ABC class Client link Client "./_autosummary/cosapp.systems.externalsystem.html#cosapp.systems.externalsystem.Client" "Client" Communication <|-- Client class Communication link Communication "./_autosummary/cosapp.systems.externalsystem.html#cosapp.systems.externalsystem.Communication" "Communication" class Component link Component "./_autosummary/cosapp.patterns.visitor.html#cosapp.patterns.visitor.Component" "Abstract Base Class for visited components" class ConversionType link ConversionType "./_autosummary/cosapp.systems.system.html#cosapp.systems.system.ConversionType" "Enumeration of `System` conversion type." Enum <|-- ConversionType class Enum class ExternalSystem link ExternalSystem "./_autosummary/cosapp.systems.externalsystem.html#cosapp.systems.externalsystem.ExternalSystem" "ExternalSystem" System <|-- ExternalSystem class LoggerContext link LoggerContext "./_autosummary/cosapp.utils.logging.html#cosapp.utils.logging.LoggerContext" "Interface for context object to connect to the logging system." class MetaSystem link MetaSystem "./_autosummary/cosapp.systems.metamodels.html#cosapp.systems.metamodels.MetaSystem" "Based :py:class:`~cosapp.systems.system.System` to insert meta-system inside CoSApp." System <|-- MetaSystem class Module link Module "./_autosummary/cosapp.core.module.html#cosapp.core.module.Module" "A class to describe generic properties and functions of a component that can be single or" LoggerContext <|-- Module Component <|-- Module class Observer link Observer "./_autosummary/cosapp.patterns.observer.html#cosapp.patterns.observer.Observer" "Generic interface for observers" ABC <|-- Observer class ProcessSystem link ProcessSystem "./_autosummary/cosapp.systems.processsystem.html#cosapp.systems.processsystem.ProcessSystem" "ProcessSystem" ExternalSystem <|-- ProcessSystem class Server link Server "./_autosummary/cosapp.systems.externalsystem.html#cosapp.systems.externalsystem.Server" "Server" Communication <|-- Server class System link System "./_autosummary/cosapp.systems.system.html#cosapp.systems.system.System" "A class to describe generic properties and functions of a component that can be single or" Module <|-- System TimeObserver <|-- System class SystemFamily link SystemFamily "./_autosummary/cosapp.systems.systemfamily.html#cosapp.systems.systemfamily.SystemFamily" "Abstract class defining a family of `System` convertible in one another." System <|-- SystemFamily class SystemFamilyModelings link SystemFamilyModelings "./_autosummary/cosapp.systems.systemfamily.html#cosapp.systems.systemfamily.SystemFamilyModelings" "SystemFamilyModelings" class TCPSystem link TCPSystem "./_autosummary/cosapp.systems.externalsystem.html#cosapp.systems.externalsystem.TCPSystem" "TCPSystem" ExternalSystem <|-- TCPSystem class TimeObserver link TimeObserver "./_autosummary/cosapp.core.time.html#cosapp.core.time.TimeObserver" "Abstract time observer." Observer <|-- TimeObserver