pyoculus.solvers.base_solver.BaseSolver Class Reference

Abstract class that used to setup all other solvers. More...

Inheritance diagram for pyoculus.solvers.base_solver.BaseSolver:

Classes
class	OutputData
	Used to return the output data. More...

Public Member Functions
	__init__ (self, problem, params=dict(), integrator=None, integrator_params=dict())
	Sets up the solver.
	is_successful (self)
	Returns True if the computation is successfully completed.

Public Attributes
bool	successful = False
	flagging if the computation is done and successful

Protected Attributes
	_integrator_type = RKIntegrator
	_params = dict(params)
	_integrator = self._integrator_type(integrator_params)
	_problem = problem
	_integrator_params = dict(integrator_params)

Detailed Description

Abstract class that used to setup all other solvers.

Constructor & Destructor Documentation

__init__()

pyoculus.solvers.base_solver.BaseSolver.__init__	(		self,
			problem,
			params = dict(),
			integrator = None,
			integrator_params = dict() )

Sets up the solver.

Parameters

problem	must inherit pyoculus.problems.BaseProblem, the problem to solve
params	dict, the parameters for the solver
integrator	the integrator to use, must inherit pyoculus.integrators.BaseIntegrator, if set to None by default using RKIntegrator
integrator_params	dict, the parmaters passed to the integrator

Reimplemented in pyoculus.solvers.fixed_point.FixedPoint, pyoculus.solvers.flux_surface_gr.FluxSurfaceGR, pyoculus.solvers.lyapunov_exponent.LyapunovExponent, pyoculus.solvers.poincare_plot.PoincarePlot, and pyoculus.solvers.qfm.QFM.

Member Function Documentation

is_successful()

pyoculus.solvers.base_solver.BaseSolver.is_successful

(

self

)

Returns True if the computation is successfully completed.

Returns

successful – True if the computation is successfully completed, False otherwise

Member Data Documentation

_integrator

pyoculus.solvers.base_solver.BaseSolver._integrator = self._integrator_type(integrator_params)

protected

_integrator_params

pyoculus.solvers.base_solver.BaseSolver._integrator_params = dict(integrator_params)

protected

_integrator_type

pyoculus.solvers.base_solver.BaseSolver._integrator_type = RKIntegrator

protected

_params

pyoculus.solvers.base_solver.BaseSolver._params = dict(params)

protected

_problem

pyoculus.solvers.base_solver.BaseSolver._problem = problem

protected

successful

bool pyoculus.solvers.base_solver.BaseSolver.successful = False

flagging if the computation is done and successful

---

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

• pyoculus/solvers/base_solver.py