Solver class which uses Differential Algebraic Equation(DAE) systems. More...

#include <DAESolver.h>

Inheritance diagram for DPsim::DAESolver:

Collaboration diagram for DPsim::DAESolver:

Public Member Functions
	DAESolver (String name, const CPS::SystemTopology &system, Real dt, Real mT0)
	Create solve object with given parameters.

	~DAESolver ()
	Deallocate all memory.

void	initialize () final
	Initialize Components & Nodes with initial values.

Real	step (Real time)
	Solve system for the current time.

CPS::Task::List	getTasks () override
	Get tasks for scheduler.

Public Member Functions inherited from DPsim::Solver
	Solver (String name, CPS::Logger::Level logLevel)

void	setTimeStep (Real timeStep)

void	doFrequencyParallelization (Bool freqParallel)

virtual void	setSystem (const CPS::SystemTopology &system)

void	doSystemMatrixRecomputation (Bool value)

void	setLogSolveTimes (Bool value)

void	doSteadyStateInit (Bool f)
	activate steady state initialization

void	setSteadStIniTimeLimit (Real v)
	set steady state initialization time limit

void	setSteadStIniAccLimit (Real v)
	set steady state initialization accuracy limit

virtual void	setSolverAndComponentBehaviour (Solver::Behaviour behaviour)
	set solver and component to initialization or simulation behaviour

void	doInitFromNodesAndTerminals (Bool f)
	activate powerflow initialization

virtual void	setDirectLinearSolverConfiguration (DirectLinearSolverConfiguration &)
	set direct linear solver configuration (only available in MNA for now)

virtual void	logLUTimes ()
	log LU decomposition times, if applicable

virtual void	log (Real time, Int timeStepCount)
	Log results.

void	setMaxNumberOfIterations (int maxIterations)

Protected Member Functions
int	residualFunction (realtype ttime, N_Vector state, N_Vector dstate_dt, N_Vector resid)

Static Protected Member Functions
static int	residualFunctionWrapper (realtype ttime, N_Vector state, N_Vector dstate_dt, N_Vector resid, void *user_data)
	Residual Function of entire System.

Protected Attributes
CPS::SystemTopology	mSystem

std::vector< Int >	mOffsets
	Offsets vector for adding new equations to the residual vector.

Real	mTimestep
	Constant time step.

Int	mNEQ
	Number of equations in problem.

CPS::IdentifiedObject::List	mComponents
	Components of the Problem.

CPS::SimNode< Complex >::List	mNodes
	Nodes of the Problem.

Real	mT0

void *	mem = NULL
	Memory block allocated by IDA.

N_Vector	state = NULL
	Vector of problem variables.

N_Vector	dstate_dt = NULL
	Derivates of the state vector with respect to time.

realtype	tret
	Time IDA reached while solving.

realtype	abstol
	Scalar absolute tolerance.

realtype	rtol
	Relative tolerance.

SUNMatrix	A = NULL
	Template Jacobian Matrix.

SUNLinearSolver	LS = NULL
	Linear solver object.

long int	interalSteps = 0

long int	resEval = 0

std::vector< CPS::DAEInterface::ResFn >	mResidualFunctions

Protected Attributes inherited from DPsim::Solver
String	mName
	Name for logging.

CPS::Logger::Level	mLogLevel
	Logging level.

Bool	mLogSolveTimes = true
	Collect step time for logging.

CPS::Logger::Log	mSLog
	Logger.

Real	mTimeStep
	Time step for fixed step solvers.

Bool	mFrequencyParallel = false
	Activates parallelized computation of frequencies.

Real	mSteadStIniTimeLimit = 10
	steady state initialization time limit

Real	mSteadStIniAccLimit = 0.0001
	steady state initialization accuracy limit

Bool	mSteadyStateInit = false
	Activates steady state initialization.

Bool	mIsInInitialization = false
	Determines if solver is in initialization phase, which requires different behavior.

Bool	mInitFromNodesAndTerminals = true

Bool	mSystemMatrixRecomputation = false
	Enable recomputation of system matrix during simulation.

Behaviour	mBehaviour = Solver::Behaviour::Simulation
	Solver behaviour initialization or simulation.

Additional Inherited Members
Public Types inherited from DPsim::Solver
enum	Behaviour { Initialization , Simulation }

enum class	Type { MNA , DAE , NRP }

typedef std::shared_ptr< Solver >	Ptr

typedef std::vector< Ptr >	List

Public Attributes inherited from DPsim::Solver
int	mMaxIterations = 10

Detailed Description

Solver class which uses Differential Algebraic Equation(DAE) systems.

Definition at line 30 of file DAESolver.h.

Constructor & Destructor Documentation

◆ DAESolver()

DAESolver::DAESolver	(	String	name,
		const CPS::SystemTopology &	system,
		Real	dt,
		Real	mT0 )

Create solve object with given parameters.

Definition at line 18 of file DAESolver.cpp.

◆ ~DAESolver()

DAESolver::~DAESolver ( )

Deallocate all memory.

Definition at line 234 of file DAESolver.cpp.

Member Function Documentation

◆ getTasks()

Task::List DAESolver::getTasks ( )

overridevirtual

Get tasks for scheduler.

Implements DPsim::Solver.

Definition at line 229 of file DAESolver.cpp.

◆ initialize()

void DAESolver::initialize ( )

finalvirtual

Initialize Components & Nodes with initial values.

Reimplemented from DPsim::Solver.

Definition at line 73 of file DAESolver.cpp.

◆ residualFunction()

int DAESolver::residualFunction	(	realtype	ttime,
		N_Vector	state,
		N_Vector	dstate_dt,
		N_Vector	resid )

protected

Definition at line 181 of file DAESolver.cpp.

◆ residualFunctionWrapper()

int DAESolver::residualFunctionWrapper	(	realtype	ttime,
		N_Vector	state,
		N_Vector	dstate_dt,
		N_Vector	resid,
		void *	user_data )

staticprotected

Residual Function of entire System.

Definition at line 173 of file DAESolver.cpp.

◆ step()

Real DAESolver::step ( Real time )

Solve system for the current time.

Definition at line 209 of file DAESolver.cpp.

Member Data Documentation

◆ A

SUNMatrix DPsim::DAESolver::A = NULL

protected

Template Jacobian Matrix.

Definition at line 62 of file DAESolver.h.

◆ abstol

realtype DPsim::DAESolver::abstol

protected

Scalar absolute tolerance.

Definition at line 58 of file DAESolver.h.

◆ dstate_dt

N_Vector DPsim::DAESolver::dstate_dt = NULL

protected

Derivates of the state vector with respect to time.

Definition at line 54 of file DAESolver.h.

◆ interalSteps

long int DPsim::DAESolver::interalSteps = 0

protected

Definition at line 65 of file DAESolver.h.

◆ LS

SUNLinearSolver DPsim::DAESolver::LS = NULL

protected

Linear solver object.

Definition at line 64 of file DAESolver.h.

◆ mComponents

CPS::IdentifiedObject::List DPsim::DAESolver::mComponents

protected

Components of the Problem.

Definition at line 41 of file DAESolver.h.

◆ mem

void* DPsim::DAESolver::mem = NULL

protected

Memory block allocated by IDA.

Definition at line 50 of file DAESolver.h.

◆ mNEQ

Int DPsim::DAESolver::mNEQ

protected

Number of equations in problem.

Definition at line 39 of file DAESolver.h.

◆ mNodes

CPS::SimNode<Complex>::List DPsim::DAESolver::mNodes

protected

Nodes of the Problem.

Definition at line 43 of file DAESolver.h.

◆ mOffsets

std::vector<Int> DPsim::DAESolver::mOffsets

protected

Offsets vector for adding new equations to the residual vector.

Definition at line 35 of file DAESolver.h.

◆ mResidualFunctions

std::vector<CPS::DAEInterface::ResFn> DPsim::DAESolver::mResidualFunctions

protected

Definition at line 67 of file DAESolver.h.

◆ mSystem

CPS::SystemTopology DPsim::DAESolver::mSystem

protected

Definition at line 33 of file DAESolver.h.

◆ mT0

Real DPsim::DAESolver::mT0

protected

Definition at line 46 of file DAESolver.h.

◆ mTimestep

Real DPsim::DAESolver::mTimestep

protected

Constant time step.

Definition at line 37 of file DAESolver.h.

◆ resEval

long int DPsim::DAESolver::resEval = 0

protected

Definition at line 66 of file DAESolver.h.

◆ rtol

realtype DPsim::DAESolver::rtol

protected

Relative tolerance.

Definition at line 60 of file DAESolver.h.

◆ state

N_Vector DPsim::DAESolver::state = NULL

protected

Vector of problem variables.

Definition at line 52 of file DAESolver.h.

◆ tret

realtype DPsim::DAESolver::tret

protected

Time IDA reached while solving.

Definition at line 56 of file DAESolver.h.

The documentation for this class was generated from the following files:

/__w/dpsim/dpsim/dpsim/include/dpsim/DAESolver.h
/__w/dpsim/dpsim/dpsim/src/DAESolver.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DAESolver()

◆ ~DAESolver()

Member Function Documentation

◆ getTasks()

◆ initialize()

◆ residualFunction()

◆ residualFunctionWrapper()

◆ step()

Member Data Documentation

◆ A

◆ abstol

◆ dstate_dt

◆ interalSteps

◆ LS

◆ mComponents

◆ mem

◆ mNEQ

◆ mNodes

◆ mOffsets

◆ mResidualFunctions

◆ mSystem

◆ mT0

◆ mTimestep

◆ resEval

◆ rtol

◆ state

◆ tret