DirectedGraph.h

Go to the documentation of this file.

/*
 * This file is part of OpenModelica.
 *
 * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC),
 * c/o Linköpings universitet, Department of Computer and Information Science,
 * SE-58183 Linköping, Sweden.
 *
 * All rights reserved.
 *
 * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF AGPL VERSION 3 LICENSE OR
 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
 *
 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
 * Public License (OSMC-PL) are obtained from OSMC, either from the above
 * address, from the URLs:
 * http://www.openmodelica.org or
 * https://github.com/OpenModelica/ or
 * http://www.ida.liu.se/projects/OpenModelica,
 * and in the OpenModelica distribution.
 *
 * GNU AGPL version 3 is obtained from:
 * https://www.gnu.org/licenses/licenses.html#GPL
 *
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
 *
 * See the full OSMC Public License conditions for more details.
 *
 */
 
#ifndef _OMS_DIRECTED_GRAPH_H_
#define _OMS_DIRECTED_GRAPH_H_
 
#include "ComRef.h"
#include "Connector.h"
#include "Connection.h"
#include "Variable.h"
#include "OMSimulator/Types.h"
#include <deque>
#include <map>
#include <set>
#include <stack>
#include <string>
#include <vector>
 
namespace oms
{
  struct scc_t
  {
    std::vector< std::pair<int, int> > connections;
    bool thisIsALoop; // needed because a SSC with just one connection can be a loop! fmu.y -> fmu.u
    unsigned int size;
    unsigned int size_including_internal;
    std::set<oms::ComRef> component_names;
    double factor;
    bool suppressUnitConversion;
    oms_linear_transformation_t linearTransformation;
  };
 
  class DirectedGraph
  {
  public:
    DirectedGraph();
    ~DirectedGraph();
 
    void clear();
 
    int addNode(const Connector& var);
    void addEdge(const Connector& var1, const Connector& var2);
 
    void dotExport(const std::string& filename);
 
    void includeGraph(const DirectedGraph& graph, const ComRef& prefix);
 
    const std::vector< scc_t >& getSortedConnections();
 
    const std::vector<Connector>& getNodes() const {return nodes;}
    const scc_t& getEdges() const {return edges;}
 
    void setUnits(Connector* conA, Connector* conB, Connection* connection);
    void dumpNodes() const;
 
  private:
    std::deque< std::vector<int> > getSCCs();
    void calculateSortedConnections();
    void strongconnect(int v, std::vector< std::vector<int> > G, int& index, int *d, int *low, std::stack<int>& S, bool *stacked, std::deque< std::vector<int> >& components);
 
    static int getEdgeIndex(const scc_t& edges, int from, int to);
 
  private:
    std::vector<Connector> nodes;
    scc_t edges;
 
    std::vector< std::vector<int> > G;
    std::vector< scc_t > sortedConnections;
    bool sortedConnectionsAreValid;
 
    std::vector<Connection*> connections; // needed to set the units and resolve linear transformation of the connections in the strongly connected components
  };
}
 
#endif