flint_base::init Interface Reference

Interface for the Initializaition method. It must be called before Integration. More...

Collaboration diagram for flint_base::init:

Public Member Functions
subroutine	init (me, de, maxsteps, method, atol, rtol, interpon, interpstates, minstepsize, maxstepsize, stepszparams, eventson, eventstepsz, eventoptions, eventtol)

Detailed Description

Interface for the Initializaition method. It must be called before Integration.

Definition at line 318 of file FLINT_base.f90.

Constructor & Destructor Documentation

init()

subroutine flint_base::init::init ( class(flint_class), intent(inout) me, class(diffeqsys), target de, integer, intent(in) maxsteps, integer, intent(in), optional method, real(wp), dimension(:), intent(in), optional atol, real(wp), dimension(:), intent(in), optional rtol, logical, intent(in), optional interpon, integer, dimension(:), intent(in), optional interpstates, real(wp), intent(in), optional minstepsize, real(wp), intent(in), optional maxstepsize, real(wp), dimension(6), intent(in), optional stepszparams, logical, intent(in), optional eventson, real(wp), dimension(:), intent(in), optional eventstepsz, integer(kind(flint_eventoption_rootfinding)), dimension(:), intent(in), optional eventoptions, real(wp), dimension(:), intent(in), optional eventtol )

virtual

Parameters

[in,out]	me	Object
	de	Differential Equation system object
[in]	maxsteps	Must specify max no. of steps The implementation can use this number to decide how and how much to allocate internal storage for storing integrator natural steps as well as the interpolation coefficients for delayed interpolation.
[in]	method	Type of Intergrator to use. Implemented methods are: ERK_DOP853 (default) ERK_DOP54 ERK_VERNER98R ERK_VERNER65E
[in]	atol	Absolute tolerance, size must be either 1 or n
[in]	rtol	Relative tolerance, size must be either 1 or n
[in]	interpon	If true, then the interpolation coefficients along with integrator natural steps are computed and stored internally. User can use Interpolate method to compute solutions at any value of the indepedent variable without doing the actual integrating again. Note that if InterpOn is true, then IntStepsOn option of Integrate must be either omitted or set to false.
[in]	interpstates	Specify the interpolation states for which the interpolation coefficients will be computed and stored, e.g. [1,3,4,6,n].
[in]	minstepsize	User can specify minimum and maximum step sizes allowed. Note that these are positive quantities. Sign will be handled bu FLINT.
[in]	maxstepsize	User can specify minimum and maximum step sizes allowed. Note that these are positive quantities. Sign will be handled bu FLINT.
[in]	stepszparams	Step-size computation specific parameters. User can specify these for a specific step-size computation method, otherwise defaults are used. For Hairer's DOPRI5/DOP853 codes: StepSzParams(1): Safety-factor StepSzParams(2): Minimum safety-factor StepSzParams(3): Maximum safety-factor StepSzParams(4): Lund Stabilization parameter beta StepSzParams(5): Lund Stabilization parameter beta multiplier StepSzParams(6): Lund Stabilization PI control term initial value
[in]	eventson	Set true for events detection
[in]	eventstepsz	If events detection is enabled, then user can specify the maximum interval after which events must be checked. If there are even number of sign changes between X and X+EventStepSz, that event cannot be detected. If EventStepSz is not specified, then events are always checked at the integrator's natural steps. Note that these are positive quantities and FLINT will take care of the appropriate sign based on the direction of integration.
[in]	eventoptions	Event Options that control the event information returned by FLINT Default is FLINT_EVENTOPTION_ROOTFINDING.
[in]	eventtol	Event tolerance values used for root-finding if enabled, size must be m

Definition at line 318 of file FLINT_base.f90.

References flint_base::flint_eventoption_rootfinding.

---

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

• src/FLINT_base.f90