org.javafmi.framework.ModelDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fmu-wrapper Show documentation

javaFMI is a Java Library for the functional mock-up interface (or FMI). FMI defines a standardized interface to be used in computer simulations. The FMI Standard has beed developed by a large number of software companies and research centers that have worked in a cooperation project under the name of MODELISAR. This library addresses the connection of a java application with a FMU (functional mock-up unit).

The newest version!

/*
 *  Copyright 2013-2018 - Monentia
 *
 * Daccosim is a collaborative development effort between EDF (France),
 *  CentraleSupélec (France), EIFER Institute (Germany), SIANI institute (Spain)
 *  and Monentia S.L. (Spain)
 *
 *  This File is part of JavaFMI Project
 *
 *  JavaFMI Project is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License.
 *
 *  JavaFMI Project is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with JavaFMI. If not, see .
 */

package org.javafmi.framework;

import java.util.List;

public interface ModelDescription {
    String fmiVersion();

    String modelName();

    String author();

    String guid();

    String description();

    String version();

    String copyright();

    String license();

    String generationTool();

    String generationDateAndTime();

    String variableNamingConvention();

    Integer numberOfEventIndicators();

    CoSimulation coSimulation();

    DefaultExperiment defaultExperiment();

    List variables();

    ModelStructure modelStructure();

    enum VariableNamingConvention {structured, flat;}

    interface DefaultExperiment {
        Double startTime();

        Double stopTime();

        Double tolerance();

        Double stepSize();
    }


    interface CoSimulation {
        String modelIdentifier();

        Boolean needsExecutionTool();

        Boolean canHandleVariableCommunicationStepSize();

        Boolean canInterpolateInputs();

        Integer maxOutputDerivativeOrder();

        Boolean canRunAsynchronously();

        Boolean canBeInstantiatedOnlyOncePerProcess();

        Boolean canNotUseMemoryManagementFunctions();

        Boolean canGetAndSetFMUstate();

        Boolean canSerializeFMUstate();

        Boolean providesDirectionalDerivative();
    }

    interface ScalarVariable {

        String name();

        int valueReference();

        String description();

        String causality();

        String variability();

        String initial();

        Integer previous();

        boolean canHandleMultipleSetPerTimeInstant();
    }

    interface IntegerVariable extends ScalarVariable {

        String quantity();

        Integer min();

        Integer max();

        Integer start();
    }

    interface RealVariable extends ScalarVariable {

        String quantity();

        String unit();

        String displayUnit();

        Boolean relativeQuantity();

        Double min();

        Double max();

        Double nominal();

        Boolean unbounded();

        Double start();

        Integer derivative();

        Boolean reinit();
    }

    interface StringVariable extends ScalarVariable {

        String start();
    }

    interface BooleanVariable extends ScalarVariable {

        Boolean start();
    }

    interface ModelStructure {

        Outputs outputs();

        Derivatives derivatives();

        InitialUnknowns initialUnknowns();
    }

    interface Outputs {

        List unknowns();
    }

    interface Derivatives {
        List unknowns();
    }

    interface InitialUnknowns {
        List unknowns();
    }

    interface Unknown {
        String index();

        String dependencies();

        String dependenciesKind();
    }

}