Solver Class Reference

Inheritance diagram for Solver:

Public Member Functions
virtual bool	Solve (double timeStepInDays)=0
void	Connect (Processor *processor)
virtual void	InitializeContainers ()=0

Static Public Member Functions
static std::unique_ptr< Solver >	Factory (const SolverSettings &solverSettings)

Protected Attributes
Processor *	_processor

Member Function Documentation

Connect()

void Solver::Connect ( Processor * processor )

inline

Connect the solver to a processor.

Parameters

processor

The processor to connect with.

Factory()

std::unique_ptr< Solver > Solver::Factory ( const SolverSettings & solverSettings )

static

Create the solver based on the provided settings.

Parameters

solverSettings

The solver settings.

Returns

A new generated solver.

InitializeContainers()

virtual void Solver::InitializeContainers ( )

pure virtual

Allocate the internal rate and state buffers to the needed size. Must be called after Connect(), once the processor knows its connection and state counts.

Implemented in SolverEulerExplicit, SolverHeunExplicit, SolverRK4, and SolverSequential.

Solve()

virtual bool Solver::Solve ( double timeStepInDays )

pure virtual

Apply the solver.

Parameters

timeStepInDays

The time step in days.

Returns

True if success, false otherwise.

Implemented in SolverEulerExplicit, SolverHeunExplicit, SolverRK4, and SolverSequential.

---

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

• /github/workspace/core/src/base/Solver.h
• /github/workspace/core/src/base/Solver.cpp