DPsim
Loading...
Searching...
No Matches
main.cpp
1/* Copyright 2017-2021 Institute for Automation of Complex Power Systems,
2 * EONERC, RWTH Aachen University
3 *
4 * This Source Code Form is subject to the terms of the Mozilla Public
5 * License, v. 2.0. If a copy of the MPL was not distributed with this
6 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 *********************************************************************************/
8
9#include <iomanip>
10
11#include <pybind11/complex.h>
12#include <pybind11/eigen.h>
13#include <pybind11/functional.h>
14#include <pybind11/iostream.h>
15#include <pybind11/pybind11.h>
16#include <pybind11/stl.h>
17
18#include <DPsim.h>
19#include <dpsim-models/IdentifiedObject.h>
20#include <dpsim/RealTimeSimulation.h>
21#include <dpsim/Simulation.h>
22
23#include <dpsim-models/CSVReader.h>
24
25#include <dpsim/pybind/Attributes.h>
26#include <dpsim/pybind/BaseComponents.h>
27#include <dpsim/pybind/DPComponents.h>
28#include <dpsim/pybind/EMTComponents.h>
29#include <dpsim/pybind/SPComponents.h>
30#include <dpsim/pybind/SignalComponents.h>
31#include <dpsim/pybind/Utils.h>
32
33PYBIND11_DECLARE_HOLDER_TYPE(T, CPS::AttributePointer<T>);
34
35namespace py = pybind11;
36using namespace pybind11::literals;
37
38PYBIND11_MODULE(dpsimpy, m) {
39 m.doc() = R"pbdoc(
40 DPsim Python bindings
41 -----------------------
42 The Python bindings provide access to most of the DPsim features implemented in C++.
43 It is possible to run powerflow, quasi-static, dynamic phasor and electromagnetic transient simulations
44 and to parameterize all components of the network from Python.
45 )pbdoc";
46
47 //Enums
48 py::enum_<CPS::Logger::Level>(m, "LogLevel")
49 .value("trace", CPS::Logger::Level::trace)
50 .value("debug", CPS::Logger::Level::debug)
51 .value("info", CPS::Logger::Level::info)
52 .value("warn", CPS::Logger::Level::warn)
53 .value("err", CPS::Logger::Level::err)
54 .value("critical", CPS::Logger::Level::critical)
55 .value("off", CPS::Logger::Level::off);
56
57 py::class_<CPS::Math>(m, "Math")
58 .def_static("single_phase_variable_to_three_phase",
59 &CPS::Math::singlePhaseVariableToThreePhase)
60 .def_static("single_phase_parameter_to_three_phase",
61 &CPS::Math::singlePhaseParameterToThreePhase)
62 .def_static("single_phase_power_to_three_phase",
63 &CPS::Math::singlePhasePowerToThreePhase);
64
65 py::enum_<DPsim::Solver::Behaviour>(m, "SolverBehaviour")
66 .value("Initialization", DPsim::Solver::Behaviour::Initialization)
67 .value("Simulation", DPsim::Solver::Behaviour::Simulation);
68
69 py::enum_<CPS::Domain>(m, "Domain")
70 .value("SP", CPS::Domain::SP)
71 .value("DP", CPS::Domain::DP)
72 .value("EMT", CPS::Domain::EMT);
73
74 py::enum_<CPS::PhaseType>(m, "PhaseType")
75 .value("A", CPS::PhaseType::A)
76 .value("B", CPS::PhaseType::B)
77 .value("C", CPS::PhaseType::C)
78 .value("ABC", CPS::PhaseType::ABC)
79 .value("Single", CPS::PhaseType::Single);
80
81 py::enum_<CPS::PowerflowBusType>(m, "PowerflowBusType")
82 .value("PV", CPS::PowerflowBusType::PV)
83 .value("PQ", CPS::PowerflowBusType::PQ)
84 .value("VD", CPS::PowerflowBusType::VD)
85 .value("None", CPS::PowerflowBusType::None);
86
87 py::enum_<CPS::GeneratorType>(m, "GeneratorType")
88 .value("PVNode", CPS::GeneratorType::PVNode)
89 .value("TransientStability", CPS::GeneratorType::TransientStability)
90 .value("IdealVoltageSource", CPS::GeneratorType::IdealVoltageSource)
91 .value("SG3OrderVBR", CPS::GeneratorType::SG3OrderVBR)
92 .value("SG4OrderVBR", CPS::GeneratorType::SG4OrderVBR)
93 .value("SG5OrderVBR", CPS::GeneratorType::SG5OrderVBR)
94 .value("SG6aOrderVBR", CPS::GeneratorType::SG6aOrderVBR)
95 .value("SG6bOrderVBR", CPS::GeneratorType::SG6bOrderVBR)
96 .value("FullOrderVBR", CPS::GeneratorType::FullOrderVBR)
97 .value("FullOrder", CPS::GeneratorType::FullOrder)
98 .value("NONE", CPS::GeneratorType::None);
99
100 py::enum_<DPsim::Solver::Type>(m, "Solver")
101 .value("MNA", DPsim::Solver::Type::MNA)
102 .value("DAE", DPsim::Solver::Type::DAE)
103 .value("NRP", DPsim::Solver::Type::NRP);
104
105 py::enum_<DPsim::DirectLinearSolverImpl>(m, "DirectLinearSolverImpl")
106 .value("Undef", DPsim::DirectLinearSolverImpl::Undef)
107 .value("DenseLU", DPsim::DirectLinearSolverImpl::DenseLU)
108 .value("SparseLU", DPsim::DirectLinearSolverImpl::SparseLU)
109 .value("KLU", DPsim::DirectLinearSolverImpl::KLU)
110 .value("CUDADense", DPsim::DirectLinearSolverImpl::CUDADense)
111 .value("CUDASparse", DPsim::DirectLinearSolverImpl::CUDASparse)
112 .value("CUDAMagma", DPsim::DirectLinearSolverImpl::CUDAMagma);
113
114 py::enum_<DPsim::SCALING_METHOD>(m, "scaling_method")
115 .value("no_scaling", DPsim::SCALING_METHOD::NO_SCALING)
116 .value("sum_scaling", DPsim::SCALING_METHOD::SUM_SCALING)
117 .value("max_scaling", DPsim::SCALING_METHOD::MAX_SCALING);
118
119 py::enum_<DPsim::FILL_IN_REDUCTION_METHOD>(m, "fill_in_reduction_method")
120 .value("amd", DPsim::FILL_IN_REDUCTION_METHOD::AMD)
121 .value("amd_nv", DPsim::FILL_IN_REDUCTION_METHOD::AMD_NV)
122 .value("amd_ra", DPsim::FILL_IN_REDUCTION_METHOD::AMD_RA)
123 .value("colamd", DPsim::FILL_IN_REDUCTION_METHOD::COLAMD);
124
125 py::enum_<DPsim::PARTIAL_REFACTORIZATION_METHOD>(
126 m, "partial_refactorization_method")
127 .value("no_partial_refactorization",
128 DPsim::PARTIAL_REFACTORIZATION_METHOD::NO_PARTIAL_REFACTORIZATION)
129 .value("factorization_path",
130 DPsim::PARTIAL_REFACTORIZATION_METHOD::FACTORIZATION_PATH)
131 .value("refactorization_restart",
132 DPsim::PARTIAL_REFACTORIZATION_METHOD::REFACTORIZATION_RESTART);
133
134 py::enum_<DPsim::USE_BTF>(m, "use_btf")
135 .value("no_btf", DPsim::USE_BTF::NO_BTF)
136 .value("do_btf", DPsim::USE_BTF::DO_BTF);
137
138 py::enum_<CPS::CSVReader::Mode>(m, "CSVReaderMode")
139 .value("AUTO", CPS::CSVReader::Mode::AUTO)
140 .value("MANUAL", CPS::CSVReader::Mode::MANUAL);
141
142 py::enum_<CPS::CSVReader::DataFormat>(m, "CSVReaderFormat")
143 .value("HHMMSS", CPS::CSVReader::DataFormat::HHMMSS)
144 .value("SECONDS", CPS::CSVReader::DataFormat::SECONDS)
145 .value("HOURS", CPS::CSVReader::DataFormat::HOURS)
146 .value("MINUTES", CPS::CSVReader::DataFormat::MINUTES);
147
148 m.attr("RMS3PH_TO_PEAK1PH") = RMS3PH_TO_PEAK1PH;
149 m.attr("PEAK1PH_TO_RMS3PH") = PEAK1PH_TO_RMS3PH;
150 m.attr("P_SNUB_TRANSFORMER") = P_SNUB_TRANSFORMER;
151 m.attr("Q_SNUB_TRANSFORMER") = Q_SNUB_TRANSFORMER;
152
153 addAttributes(m);
154
155 py::class_<DPsim::DirectLinearSolverConfiguration>(
156 m, "DirectLinearSolverConfiguration")
157 .def(py::init<>())
158 .def("set_fill_in_reduction_method",
159 &DPsim::DirectLinearSolverConfiguration::setFillInReductionMethod)
160 .def("set_scaling_method",
161 &DPsim::DirectLinearSolverConfiguration::setScalingMethod)
162 .def("set_partial_refactorization_method",
163 &DPsim::DirectLinearSolverConfiguration::
164 setPartialRefactorizationMethod)
165 .def("set_btf", &DPsim::DirectLinearSolverConfiguration::setBTF)
166 .def("get_scaling_method",
167 &DPsim::DirectLinearSolverConfiguration::getScalingMethod)
168 .def("get_fill_in_reduction_method",
169 &DPsim::DirectLinearSolverConfiguration::getFillInReductionMethod)
170 .def("get_partial_refactorization_method",
171 &DPsim::DirectLinearSolverConfiguration::
172 getPartialRefactorizationMethod)
173 .def("get_btf", &DPsim::DirectLinearSolverConfiguration::getBTF);
174
175 py::class_<DPsim::Simulation>(m, "Simulation")
176 .def(py::init<std::string, CPS::Logger::Level>(), "name"_a,
177 "loglevel"_a = CPS::Logger::Level::off)
178 .def("name", &DPsim::Simulation::name)
179 .def("set_time_step", &DPsim::Simulation::setTimeStep)
180 .def("set_final_time", &DPsim::Simulation::setFinalTime)
181 .def("add_logger", &DPsim::Simulation::addLogger)
182 .def("set_system", &DPsim::Simulation::setSystem)
183 .def("run", &DPsim::Simulation::run)
184 .def("set_solver", &DPsim::Simulation::setSolverType)
185 .def("set_domain", &DPsim::Simulation::setDomain)
186 .def("start", &DPsim::Simulation::start)
187 .def("next", &DPsim::Simulation::next)
188 .def("stop", &DPsim::Simulation::stop)
189 .def("get_idobj_attr", &DPsim::Simulation::getIdObjAttribute, "comp"_a,
190 "attr"_a)
191 .def("add_interface", &DPsim::Simulation::addInterface, "interface"_a)
192 .def("log_idobj_attribute", &DPsim::Simulation::logIdObjAttribute,
193 "comp"_a, "attr"_a)
194 .def("log_attribute", &DPsim::Simulation::logAttribute, "name"_a,
195 "attr"_a)
196 .def("do_init_from_nodes_and_terminals",
197 &DPsim::Simulation::doInitFromNodesAndTerminals)
198 .def("do_system_matrix_recomputation",
199 &DPsim::Simulation::doSystemMatrixRecomputation)
200 .def("do_steady_state_init", &DPsim::Simulation::doSteadyStateInit)
201 .def("do_frequency_parallelization",
202 &DPsim::Simulation::doFrequencyParallelization)
203 .def("do_split_subnets", &DPsim::Simulation::doSplitSubnets)
204 .def("set_tearing_components", &DPsim::Simulation::setTearingComponents)
205 .def("add_event", &DPsim::Simulation::addEvent)
206 .def("set_solver_component_behaviour",
207 &DPsim::Simulation::setSolverAndComponentBehaviour)
208 .def("set_direct_solver_implementation",
209 &DPsim::Simulation::setDirectLinearSolverImplementation)
210 .def("set_direct_linear_solver_configuration",
211 &DPsim::Simulation::setDirectLinearSolverConfiguration)
212 .def("log_lu_times", &DPsim::Simulation::logLUTimes);
213
214 py::class_<DPsim::RealTimeSimulation, DPsim::Simulation>(m,
215 "RealTimeSimulation")
216 .def(py::init<std::string, CPS::Logger::Level>(), "name"_a,
217 "loglevel"_a = CPS::Logger::Level::info)
218 .def("name", &DPsim::RealTimeSimulation::name)
219 .def("set_time_step", &DPsim::RealTimeSimulation::setTimeStep)
220 .def("set_final_time", &DPsim::RealTimeSimulation::setFinalTime)
221 .def("add_logger", &DPsim::RealTimeSimulation::addLogger)
222 .def("set_system", &DPsim::RealTimeSimulation::setSystem)
223 .def("run",
224 static_cast<void (DPsim::RealTimeSimulation::*)(CPS::Int startIn)>(
225 &DPsim::RealTimeSimulation::run))
226 .def("set_solver", &DPsim::RealTimeSimulation::setSolverType)
227 .def("set_domain", &DPsim::RealTimeSimulation::setDomain);
228
229 py::class_<CPS::SystemTopology, std::shared_ptr<CPS::SystemTopology>>(
230 m, "SystemTopology")
231 .def(py::init<CPS::Real, CPS::TopologicalNode::List,
232 CPS::IdentifiedObject::List>())
233 .def(py::init<CPS::Real, CPS::Matrix, CPS::TopologicalNode::List,
234 CPS::IdentifiedObject::List>())
235 .def(py::init<CPS::Real>())
236 .def("add", &DPsim::SystemTopology::addComponent)
237 .def("add", &DPsim::SystemTopology::addComponents)
238 .def("node", py::overload_cast<std::string_view>(
239 &DPsim::SystemTopology::node<CPS::TopologicalNode>))
240 .def("node", py::overload_cast<CPS::UInt>(
241 &DPsim::SystemTopology::node<CPS::TopologicalNode>))
242 .def("connect_component",
243 py::overload_cast<CPS::SimPowerComp<CPS::Real>::Ptr,
244 CPS::SimNode<CPS::Real>::List>(
245 &DPsim::SystemTopology::connectComponentToNodes<CPS::Real>))
246 .def("connect_component",
247 py::overload_cast<CPS::SimPowerComp<CPS::Complex>::Ptr,
248 CPS::SimNode<CPS::Complex>::List>(
249 &DPsim::SystemTopology::connectComponentToNodes<CPS::Complex>))
250 .def("component",
251 &DPsim::SystemTopology::component<CPS::TopologicalPowerComp>)
252 .def("add_tear_component", &DPsim::SystemTopology::addTearComponent)
253#ifdef WITH_GRAPHVIZ
254 .def("_repr_svg_", &DPsim::SystemTopology::render)
255 .def("render_to_file", &DPsim::SystemTopology::renderToFile)
256#endif
257 .def_readwrite("nodes", &DPsim::SystemTopology::mNodes)
258 .def_readwrite("components", &DPsim::SystemTopology::mComponents)
259 .def_readwrite("components_at_node",
260 &DPsim::SystemTopology::mComponentsAtNode)
261 .def_readonly("tear_components", &DPsim::SystemTopology::mTearComponents)
262 .def("list_idobjects", &DPsim::SystemTopology::listIdObjects)
263 .def("init_with_powerflow", &DPsim::SystemTopology::initWithPowerflow,
264 "systemPF"_a, "domain"_a)
265 .def("add_component", &DPsim::SystemTopology::addComponent)
266 .def("add_components", &DPsim::SystemTopology::addComponents)
267 .def("remove_component", &DPsim::SystemTopology::removeComponent);
268
269 py::class_<DPsim::Interface, std::shared_ptr<DPsim::Interface>>(m,
270 "Interface");
271
272 py::class_<DPsim::DataLoggerInterface,
273 std::shared_ptr<DPsim::DataLoggerInterface>>(m,
274 "DataLoggerInterface")
275 .def("log_attribute",
276 py::overload_cast<const CPS::String &, CPS::AttributeBase::Ptr,
277 CPS::UInt, CPS::UInt>(
278 &DPsim::DataLoggerInterface::logAttribute),
279 "name"_a, "attr"_a, "max_cols"_a = 0, "max_rows"_a = 0)
281 .def("log_attribute",
282 py::overload_cast<const std::vector<CPS::String> &,
283 CPS::AttributeBase::Ptr>(
284 &DPsim::DataLoggerInterface::logAttribute),
285 "names"_a, "attr"_a)
287 .def("log_attribute",
288 [](DPsim::DataLoggerInterface &logger,
289 const std::vector<CPS::String> &names, const CPS::String &attr,
290 const CPS::IdentifiedObject &comp) {
291 logger.logAttribute(names, comp.attribute(attr));
292 });
293
294 py::class_<DPsim::DataLogger, DPsim::DataLoggerInterface,
295 std::shared_ptr<DPsim::DataLogger>>(m, "Logger")
296 .def(py::init<std::string>())
297 .def_static("set_log_dir", &CPS::Logger::setLogDir)
298 .def_static("get_log_dir", &CPS::Logger::logDir)
299 .def("log_attribute",
300 py::overload_cast<const CPS::String &, CPS::AttributeBase::Ptr,
301 CPS::UInt, CPS::UInt>(
302 &DPsim::DataLogger::logAttribute),
303 "name"_a, "attr"_a, "max_cols"_a = 0, "max_rows"_a = 0)
305 .def("log_attribute",
306 py::overload_cast<const std::vector<CPS::String> &,
307 CPS::AttributeBase::Ptr>(
308 &DPsim::DataLogger::logAttribute),
309 "names"_a, "attr"_a)
311 .def(
312 "log_attribute",
313 [](DPsim::DataLogger &logger, const CPS::String &name,
314 const CPS::String &attr, const CPS::IdentifiedObject &comp,
315 CPS::UInt rowsMax, CPS::UInt colsMax) {
316 logger.logAttribute(name, comp.attribute(attr), rowsMax, colsMax);
317 },
318 "name"_a, "attr"_a, "comp"_a, "rows_max"_a = 0, "cols_max"_a = 0)
320 .def("log_attribute",
321 [](DPsim::DataLogger &logger, const std::vector<CPS::String> &names,
322 const CPS::String &attr, const CPS::IdentifiedObject &comp) {
323 logger.logAttribute(names, comp.attribute(attr));
324 });
325
326 py::class_<DPsim::RealTimeDataLogger, DPsim::DataLoggerInterface,
327 std::shared_ptr<DPsim::RealTimeDataLogger>>(m,
328 "RealTimeDataLogger")
329
330 .def(py::init([](py::object filename, DPsim::Real final_time,
331 DPsim::Real time_step) {
332 py::object fspath =
333 py::module_::import("os").attr("fspath")(filename);
334 std::string s = py::cast<std::string>(fspath);
335 std::filesystem::path p(s);
336 return std::make_shared<DPsim::RealTimeDataLogger>(p, final_time,
337 time_step);
338 }),
339 "filename"_a, "final_time"_a, "time_step"_a)
340
341 .def(py::init([](py::object filename, std::size_t row_number) {
342 py::object fspath =
343 py::module_::import("os").attr("fspath")(filename);
344 std::string s = py::cast<std::string>(fspath);
345 std::filesystem::path p(s);
346 return std::make_shared<DPsim::RealTimeDataLogger>(p, row_number);
347 }),
348 "filename"_a, "row_number"_a)
349
350 .def("log_attribute",
351 py::overload_cast<const CPS::String &, CPS::AttributeBase::Ptr,
352 CPS::UInt, CPS::UInt>(
353 &DPsim::DataLoggerInterface::logAttribute),
354 "name"_a, "attr"_a, "max_cols"_a = 0, "max_rows"_a = 0)
355
356 .def("log_attribute",
357 py::overload_cast<const std::vector<CPS::String> &,
358 CPS::AttributeBase::Ptr>(
359 &DPsim::DataLoggerInterface::logAttribute),
360 "names"_a, "attr"_a)
361
362 .def(
363 "log_attribute",
364 [](DPsim::RealTimeDataLogger &logger, const CPS::String &name,
365 const CPS::String &attr, const CPS::IdentifiedObject &comp,
366 CPS::UInt rowsMax, CPS::UInt colsMax) {
367 logger.logAttribute(name, comp.attribute(attr), rowsMax, colsMax);
368 },
369 "name"_a, "attr"_a, "comp"_a, "rows_max"_a = 0, "cols_max"_a = 0)
370
371 .def(
372 "log_attribute",
373 [](DPsim::RealTimeDataLogger &logger,
374 const std::vector<CPS::String> &names, const CPS::String &attr,
375 const CPS::IdentifiedObject &comp) {
376 logger.logAttribute(names, comp.attribute(attr));
377 },
378 "names"_a, "attr"_a, "comp"_a);
379
380 py::class_<CPS::IdentifiedObject, std::shared_ptr<CPS::IdentifiedObject>>(
381 m, "IdentifiedObject")
382 .def("name", &CPS::IdentifiedObject::name)
386 .def("attr", &CPS::IdentifiedObject::attribute, "name"_a)
387 .def("print_attribute_list", &printAttributes)
388 .def("print_attribute", &printAttribute, "attribute_name"_a)
389 .def("__str__", &getAttributeList);
390
391#ifdef WITH_CIM
392 py::class_<CPS::CIM::Reader>(m, "CIMReader")
393 .def(py::init<std::string, CPS::Logger::Level, CPS::Logger::Level>(),
394 "name"_a, "loglevel"_a = CPS::Logger::Level::info,
395 "comploglevel"_a = CPS::Logger::Level::off)
396 .def("loadCIM", (CPS::SystemTopology(CPS::CIM::Reader::*)(
397 CPS::Real, const std::list<CPS::String> &,
398 CPS::Domain, CPS::PhaseType, CPS::GeneratorType)) &
399 CPS::CIM::Reader::loadCIM);
400#endif
401
402 py::class_<CPS::CSVReader>(m, "CSVReader")
403 .def(py::init<std::string, const std::string &,
404 std::map<std::string, std::string> &, CPS::Logger::Level>())
405 .def("assignLoadProfile", &CPS::CSVReader::assignLoadProfile);
406
407 //Base Classes
408
409 py::class_<CPS::TopologicalPowerComp,
410 std::shared_ptr<CPS::TopologicalPowerComp>, CPS::IdentifiedObject>(
411 m, "TopologicalPowerComp");
412 py::class_<CPS::SimPowerComp<CPS::Complex>,
413 std::shared_ptr<CPS::SimPowerComp<CPS::Complex>>,
414 CPS::TopologicalPowerComp>(m, "SimPowerCompComplex")
415 .def("connect", &CPS::SimPowerComp<CPS::Complex>::connect)
416 .def("set_intf_current", &CPS::SimPowerComp<CPS::Complex>::setIntfCurrent)
417 .def("set_intf_voltage", &CPS::SimPowerComp<CPS::Complex>::setIntfVoltage)
418 .def("get_terminal", &CPS::SimPowerComp<CPS::Complex>::terminal,
419 "index"_a);
420 py::class_<CPS::SimPowerComp<CPS::Real>,
421 std::shared_ptr<CPS::SimPowerComp<CPS::Real>>,
422 CPS::TopologicalPowerComp>(m, "SimPowerCompReal")
423 .def("connect", &CPS::SimPowerComp<CPS::Real>::connect)
424 .def("set_intf_current", &CPS::SimPowerComp<CPS::Real>::setIntfCurrent)
425 .def("set_intf_voltage", &CPS::SimPowerComp<CPS::Real>::setIntfVoltage)
426 .def("get_terminal", &CPS::SimPowerComp<CPS::Real>::terminal, "index"_a);
427 py::class_<CPS::TopologicalNode, std::shared_ptr<CPS::TopologicalNode>,
428 CPS::IdentifiedObject>(m, "TopologicalNode")
429 .def("initial_single_voltage",
430 &CPS::TopologicalNode::initialSingleVoltage,
431 "phase_type"_a = CPS::PhaseType::Single);
432
433 py::class_<CPS::TopologicalTerminal,
434 std::shared_ptr<CPS::TopologicalTerminal>, CPS::IdentifiedObject>(
435 m, "TopologicalTerminal")
436 .def("set_power",
437 py::overload_cast<CPS::Complex>(&CPS::TopologicalTerminal::setPower))
438 .def("set_power", py::overload_cast<CPS::MatrixComp>(
439 &CPS::TopologicalTerminal::setPower));
440
441 py::class_<CPS::SimTerminal<CPS::Complex>,
442 std::shared_ptr<CPS::SimTerminal<CPS::Complex>>,
443 CPS::TopologicalTerminal>(m, "SimTerminalComplex");
444 py::class_<CPS::SimTerminal<CPS::Real>,
445 std::shared_ptr<CPS::SimTerminal<CPS::Real>>,
446 CPS::TopologicalTerminal>(m, "SimTerminalReal");
447
448 //Events
449 py::module mEvent = m.def_submodule("event", "events");
450 py::class_<DPsim::Event, std::shared_ptr<DPsim::Event>>(mEvent, "Event");
451 py::class_<DPsim::SwitchEvent, std::shared_ptr<DPsim::SwitchEvent>,
452 DPsim::Event>(mEvent, "SwitchEvent", py::multiple_inheritance())
453 .def(py::init<CPS::Real, const std::shared_ptr<CPS::Base::Ph1::Switch>,
454 CPS::Bool>());
455 py::class_<DPsim::SwitchEvent3Ph, std::shared_ptr<DPsim::SwitchEvent3Ph>,
456 DPsim::Event>(mEvent, "SwitchEvent3Ph", py::multiple_inheritance())
457 .def(py::init<CPS::Real, const std::shared_ptr<CPS::Base::Ph3::Switch>,
458 CPS::Bool>());
459
460 //Components
461 py::module mBase = m.def_submodule("base", "base models");
462 addBaseComponents(mBase);
463
464 py::module mDP = m.def_submodule("dp", "dynamic phasor models");
465 addDPComponents(mDP);
466
467 py::module mEMT = m.def_submodule("emt", "electromagnetic-transient models");
468 addEMTComponents(mEMT);
469
470 py::module mSP = m.def_submodule("sp", "static phasor models");
471 mSP.attr("SimNode") = mDP.attr("SimNode");
472 addSPComponents(mSP);
473
474 py::module mSignal = m.def_submodule("signal", "signal models");
475 addSignalComponents(mSignal);
476
477#ifdef VERSION_INFO
478 m.attr("__version__") = VERSION_INFO;
479#else
480 m.attr("__version__") = "dev";
481#endif
482}
CPS::CIM::Reader::loadCIM
SystemTopology loadCIM(Real systemFrequency, const fs::path &filename, Domain domain=Domain::DP, PhaseType phase=PhaseType::Single, GeneratorType genType=GeneratorType::None)
Parses data from CIM files into the CPS data structure.
Definition Reader.cpp:209
CPS::CSVReader::assignLoadProfile
void assignLoadProfile(SystemTopology &sys, Real start_time=-1, Real time_step=1, Real end_time=-1, CSVReader::Mode mode=CSVReader::Mode::AUTO, CSVReader::DataFormat format=CSVReader::DataFormat::SECONDS)
assign load profile to corresponding load object
Definition CSVReader.cpp:284
CPS::IdentifiedObject::attribute
AttributeBase::Ptr attribute(const String &name) const
Return pointer to an attribute.
Definition IdentifiedObject.h:45
CPS::Logger::setLogDir
static void setLogDir(String path)
Set env variable CPS_LOG_DIR and overwrite.
Definition Logger.cpp:88
CPS::Math::singlePhasePowerToThreePhase
static Matrix singlePhasePowerToThreePhase(Real power)
To convert single phase power to symmetrical three phase.
Definition MathUtils.cpp:217
CPS::Math::singlePhaseParameterToThreePhase
static Matrix singlePhaseParameterToThreePhase(Real parameter)
To convert single phase parameters to symmetrical three phase ones.
Definition MathUtils.cpp:211
CPS::Math::singlePhaseVariableToThreePhase
static MatrixComp singlePhaseVariableToThreePhase(Complex var_1ph)
To convert single phase complex variables (voltages, currents) to symmetrical three phase ones.
Definition MathUtils.cpp:205
CPS::SimPowerComp::terminal
SimTerminal< VarType >::Ptr terminal(UInt index)
Get pointer to Terminal.
Definition SimPowerComp.cpp:146
CPS::SimPowerComp::connect
void connect(typename SimNode< VarType >::List nodes)
Sets all nodes and checks for nominal number of Nodes for this Component.
Definition SimPowerComp.cpp:265
CPS::SystemTopology::mComponents
IdentifiedObject::List mComponents
List of network components.
Definition SystemTopology.h:32
CPS::SystemTopology::node
std::shared_ptr< Type > node(UInt index)
Returns TopologicalNode by index in node list.
Definition SystemTopology.cpp:136
CPS::SystemTopology::initWithPowerflow
void initWithPowerflow(const SystemTopology &systemPF, CPS::Domain domain)
Initialize nodes and SG power from PowerFlow.
Definition SystemTopology.cpp:85
CPS::SystemTopology::removeComponent
void removeComponent(const String &name)
Remove system component.
Definition SystemTopology.cpp:246
CPS::SystemTopology::addTearComponent
void addTearComponent(IdentifiedObject::Ptr component)
Adds component and initializes frequencies.
Definition SystemTopology.cpp:117
CPS::SystemTopology::component
std::shared_ptr< Type > component(const String &name)
Returns Component by name.
Definition SystemTopology.h:130
CPS::SystemTopology::mNodes
TopologicalNode::List mNodes
List of network nodes.
Definition SystemTopology.h:30
CPS::SystemTopology::addComponents
void addComponents(const IdentifiedObject::List &components)
Add multiple components.
Definition SystemTopology.cpp:80
CPS::SystemTopology::connectComponentToNodes
void connectComponentToNodes(typename SimPowerComp< VarType >::Ptr component, typename SimNode< VarType >::List simNodes)
Connect component to simNodes.
Definition SystemTopology.cpp:63
CPS::SystemTopology::addComponent
void addComponent(IdentifiedObject::Ptr component)
Adds component and initializes frequencies.
Definition SystemTopology.cpp:51
CPS::SystemTopology::mTearComponents
IdentifiedObject::List mTearComponents
Definition SystemTopology.h:35
CPS::SystemTopology::mComponentsAtNode
std::map< TopologicalNode::Ptr, TopologicalPowerComp::List > mComponentsAtNode
Map of network components connected to network nodes.
Definition SystemTopology.h:37
DPsim::RealTimeSimulation
Extending Simulation class by real-time functionality.
Definition RealTimeSimulation.h:21
DPsim::RealTimeSimulation::run
void run(const Timer::StartClock::duration &startIn=std::chrono::seconds(1))
Definition RealTimeSimulation.cpp:28
DPsim::Simulation::doFrequencyParallelization
void doFrequencyParallelization(Bool value)
Compute phasors of different frequencies in parallel.
Definition Simulation.h:211
DPsim::Simulation::logLUTimes
void logLUTimes()
Write LU decomposition times measurements to log file.
Definition Simulation.cpp:426
DPsim::Simulation::next
Real next()
Run until next time step.
Definition Simulation.cpp:354
DPsim::Simulation::addLogger
void addLogger(DataLoggerInterface::Ptr logger)
Add a new data logger.
Definition Simulation.h:249
DPsim::Simulation::setSolverAndComponentBehaviour
void setSolverAndComponentBehaviour(Solver::Behaviour behaviour)
set solver and component to initialization or simulation behaviour
Definition Simulation.h:177
DPsim::Simulation::getIdObjAttribute
CPS::AttributeBase::Ptr getIdObjAttribute(const String &comp, const String &attr)
CHECK: Can these be deleted? getIdObjAttribute + "**attr =" should suffice.
Definition Simulation.cpp:432
DPsim::Simulation::start
void start()
Start simulation without advancing in time.
Definition Simulation.cpp:302
DPsim::Simulation::doSteadyStateInit
void doSteadyStateInit(Bool f)
activate steady state initialization
Definition Simulation.h:222
DPsim::Simulation::addEvent
void addEvent(Event::Ptr e)
Schedule an event in the simulation.
Definition Simulation.h:247
DPsim::Simulation::run
void run()
Run simulation until total time is elapsed.
Definition Simulation.cpp:363
DPsim::Simulation::logAttribute
void logAttribute(String name, CPS::AttributeBase::Ptr attr)
CHECK: Can we store the attribute name / UID intrinsically inside the attribute?
Definition Simulation.cpp:460
DPsim::Simulation::stop
void stop()
Stop simulation including scheduler and interfaces.
Definition Simulation.cpp:334
Generated by doxygen 1.13.2