rk_class – rklib

type, public :: rk_class

main integration class

Inherits

Help

Components

Type	Visibility	Attributes		Name		Initial
integer,	private		::	istatus	=	0	status code
logical,	private		::	stopped	=	.false.	if user has stopped the integration in `f` or `report`.
integer,	private		::	num_steps	=	0	number of accepted steps taken
integer,	private		::	max_number_of_steps	=	huge(1)	maximum number of steps to take
integer,	private		::	report_rate	=	1	how often to call report function: `0` : no reporting (same as not associating `report`), `1` : report every point, `2` : report every other point, etc. The first and last point are always reported.
logical,	private		::	stop_on_errors	=	.false.	if true, then errors will stop the program
integer,	private		::	n	=	0	user specified number of variables
procedure(deriv_func),	private,	pointer	::	f	=>	null()	user-specified derivative function
procedure(report_func),	private,	pointer	::	report	=>	null()	user-specified report function
procedure(event_func),	private,	pointer	::	g	=>	null()	event function (stop when this is zero)
type(root_method),	private		::	solver	=	root_method_brent	the root solver method to use for even finding
real(kind=wp),	private,	dimension(:,:), allocatable	::	funcs			matrix to store the function evalutaions in the step function. this will be size (`n` x `number_of_registers`)

Type-Bound Procedures

procedure, public :: destroy

destructor

private subroutine destroy(me)

Destructor for rk_class.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(out)			::	me

procedure, public :: stop => rk_class_stop

user-callable method to stop the integration

private subroutine rk_class_stop(me)

User-callable method to stop the integration.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(inout)			::	me

procedure, public :: status => rk_class_status

get status code and message

private subroutine rk_class_status(me, istatus, message)

Get the status of an integration.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(in)			::	me
integer,	intent(out),	optional		::	istatus	status code (`<0` means an error)
character(len=:),	intent(out),	optional,	allocatable	::	message	status message

procedure, public :: failed

private function failed(me)

Returns true if there was an error. Can use rk_class_status to get more info.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(in)			::	me

Return Value logical

procedure, private :: init => initialize_rk_class

private subroutine initialize_rk_class(me, n, f, report, g, stop_on_errors, max_number_of_steps, report_rate, solver)

Initialize the rk_class.

Arguments

Type	Intent	Optional		Name
class(rk_class),	intent(inout)		::	me
integer,	intent(in)		::	n	number of variables
procedure(deriv_func)			::	f	derivative function
procedure(report_func),		optional	::	report	for reporting the steps
procedure(event_func),		optional	::	g	for stopping at an event
logical,	intent(in),	optional	::	stop_on_errors	stop the program for any errors (default is False)
integer,	intent(in),	optional	::	max_number_of_steps	max number of steps allowed
integer,	intent(in),	optional	::	report_rate	how often to call report function: `0` : no reporting (same as not associating `report`), `1` : report every point, `2` : report every other point, etc. The first and last point are always reported.
class(root_method),	intent(in),	optional	::	solver	the root-finding method to use for even finding. if not present, then `brent_solver` is used.

procedure, private :: begin => begin_integration_rk_class

private subroutine begin_integration_rk_class(me)

Begin an integration.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(inout)			::	me

procedure, private :: raise_exception

private subroutine raise_exception(me, error_code)

Raise an exception.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(inout)			::	me
integer,	intent(in)			::	error_code	the error to raise

procedure, private :: clear_exception

private subroutine clear_exception(me)

Clear any exception.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(inout)			::	me

procedure, private :: export_point

private subroutine export_point(me, t, x, first_or_last)

Wrapper for exporting points during integration.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(inout)			::	me
real(kind=wp),	intent(in)			::	t
real(kind=wp),	intent(in),		dimension(:)	::	x
logical,	intent(in),	optional		::	first_or_last	if this is the first or last point (always reported)

procedure(begin_func), private, deferred :: begin_integration

subroutine begin_func(me) Prototype

routine called before integration begins to set up internal variables.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(inout)			::	me

procedure(properties_func), public, deferred :: properties

pure function properties_func(me) result(p) Prototype

Returns the properties of the method.

Arguments

Type	Intent	Optional	Attributes		Name
class(rk_class),	intent(in)			::	me

Return Value type(rklib_properties)

properties of the method

Source Code

    type,abstract,public :: rk_class

        !! main integration class

        private

        integer :: istatus = 0 !! status code
        logical :: stopped = .false. !! if user has stopped the integration in `f` or `report`.
        integer :: num_steps = 0 !! number of accepted steps taken
        integer :: max_number_of_steps  = huge(1) !! maximum number of steps to take
        integer :: report_rate = 1 !! how often to call report function:
                                   !! `0` : no reporting (same as not associating `report`),
                                   !! `1` : report every point,
                                   !! `2` : report every other point, etc.
                                   !! The first and last point are always reported.

        logical :: stop_on_errors = .false. !! if true, then errors will stop the program
        integer :: n = 0  !! user specified number of variables
        procedure(deriv_func),pointer  :: f      => null()  !! user-specified derivative function
        procedure(report_func),pointer :: report => null()  !! user-specified report function
        procedure(event_func),pointer  :: g      => null()  !! event function (stop when this is zero)
        type(root_method) :: solver = root_method_brent !! the root solver method to use for even finding

        real(wp),dimension(:,:),allocatable :: funcs !! matrix to store the function
                                                     !! evalutaions in the step function.
                                                     !! this will be size (`n` x `number_of_registers`)

        contains

        private

        procedure,public :: destroy !! destructor
        procedure,public :: stop => rk_class_stop !! user-callable method to stop the integration
        procedure,public :: status => rk_class_status !! get status code and message
        procedure,public :: failed

        procedure :: init => initialize_rk_class
        procedure :: begin => begin_integration_rk_class
        procedure :: raise_exception
        procedure :: clear_exception
        procedure :: export_point
        procedure(begin_func),deferred :: begin_integration
        procedure(properties_func),deferred,public :: properties

    end type rk_class

rk_class Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, public :: rk_class

Inherits

Inherited by

Components

Type-Bound Procedures

procedure, public :: destroy

private subroutine destroy(me)

Arguments

procedure, public :: stop => rk_class_stop

private subroutine rk_class_stop(me)

Arguments

procedure, public :: status => rk_class_status

private subroutine rk_class_status(me, istatus, message)

Arguments

procedure, public :: failed

private function failed(me)

Arguments

Return Value logical

procedure, private :: init => initialize_rk_class

private subroutine initialize_rk_class(me, n, f, report, g, stop_on_errors, max_number_of_steps, report_rate, solver)

Arguments

procedure, private :: begin => begin_integration_rk_class

private subroutine begin_integration_rk_class(me)

Arguments

procedure, private :: raise_exception

private subroutine raise_exception(me, error_code)

Arguments

procedure, private :: clear_exception

private subroutine clear_exception(me)

Arguments

procedure, private :: export_point

private subroutine export_point(me, t, x, first_or_last)

Arguments

procedure(begin_func), private, deferred :: begin_integration

subroutine begin_func(me) Prototype

Arguments

procedure(properties_func), public, deferred :: properties

pure function properties_func(me) result(p) Prototype

Arguments

Return Value type(rklib_properties)

Source Code