integrator_euler_explicit

type, public, extends(integrator_multistage_object) :: integrator_euler_explicit

FOODIE integrator: provide explicit Euler scheme, it being 1st order accurate.

Variables

buffer description_ error error_message registers stage stages

Source Code

Components

Type	Visibility	Attributes		Name		Initial
class(integrand_object),	public,	allocatable	::	buffer			Buffer used for fast integration.
character(len=:),	public,	allocatable	::	description_			Informative description of the integrator.
integer(kind=I_P),	public		::	error	=	0	Error status code.
character(len=:),	public,	allocatable	::	error_message			Error message, hopefully meaningful.
integer(kind=I_P),	public		::	registers			Number of registers used for stages.
class(integrand_object),	public,	allocatable	::	stage(:)			Stages.
integer(kind=I_P),	public		::	stages			Number of stages.

Type-Bound Procedures

procedure, public, pass(self) :: allocate_integrand_members

Allocate integrand members.

private subroutine allocate_integrand_members(self, U)

Allocate members of interpolator being of integrand_object class.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_multistage_object),	intent(inout)			::	self	Integrator.
class(integrand_object),	intent(in)			::	U	Integrand.

procedure, public, pass(lhs) :: assign_abstract

Assign ony members of abstract integrator_object type.

private subroutine assign_abstract(lhs, rhs)

Assign ony members of abstract integrator_object type.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_object),	intent(inout)			::	lhs	Left hand side.
class(integrator_object),	intent(in)			::	rhs	Right hand side.

procedure, public, pass(lhs) :: assign_multistage

Assign members of integrator_multistage_object and parents.

private subroutine assign_multistage(lhs, rhs)

Assign members of integrator_multistage_object and parents.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_multistage_object),	intent(inout)			::	lhs	Left hand side.
class(integrator_object),	intent(in)			::	rhs	Right hand side.

generic, public :: assignment(=) => integr_assign_integr

Overload =.

private subroutine integr_assign_integr(lhs, rhs)

Operator =.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_adams_bashforth_moulton),	intent(inout)			::	lhs	Left hand side.
class(integrator_object),	intent(in)			::	rhs	Right hand side.

procedure, public, pass(self) :: check_error

Check for error occurrencies.

private subroutine check_error(self, is_severe)

Check for error occurencies.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_object),	intent(in)			::	self	Integrator.
logical,	intent(in),	optional		::	is_severe	Flag to activate severe faliure, namely errors trigger a stop.

procedure, public, pass(self) :: class_name

Return the class name of schemes.

private pure function class_name(self)

Return the class name of schemes.

Arguments

Type Intent Optional Attributes Name

class(integrator_euler_explicit), intent(in) :: self
Integrator.

Return Value character(len=99)

Class name.

procedure, public, pass(self) :: description

Return informative integrator description.

private pure function description(self, prefix) result(desc)

Return informative integrator description.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_object),	intent(in)			::	self	Integrator.
character(len=*),	intent(in),	optional		::	prefix	Prefixing string.

Return Value character(len=:), allocatable

Description.

procedure, public, pass(self) :: destroy

Destroy the integrator.

private elemental subroutine destroy(self)

Destroy the integrator.

Arguments

Type Intent Optional Attributes Name

class(integrator_euler_explicit), intent(inout) :: self
Integrator.

procedure, public, pass(self) :: destroy_abstract

Destroy only members of abstract integrator_object type.

private elemental subroutine destroy_abstract(self)

Destroy only members of abstract integrator_object type.

Arguments

Type Intent Optional Attributes Name

class(integrator_object), intent(inout) :: self
Integrator.

procedure, public, pass(self) :: destroy_multistage

Destroy the integrator.

private elemental subroutine destroy_multistage(self)

Destroy the integrator.

Arguments

Type Intent Optional Attributes Name

class(integrator_multistage_object), intent(inout) :: self
Integrator.

procedure, public, pass(self) :: has_fast_mode

Return .true. if the integrator class has fast mode integrate.

private elemental function has_fast_mode(self)

Return .true. if the integrator class has fast mode integrate.

Arguments

Type Intent Optional Attributes Name

class(integrator_euler_explicit), intent(in) :: self
Integrator.

Return Value logical

Inquire result.

procedure, public, pass(self) :: initialize

Initialize (create) the integrator.

private subroutine initialize(self, scheme, U, stop_on_fail)

Create the actual RK integrator: initialize the Butcher' table coefficients.

Arguments

Type	Intent	Optional		Name
class(integrator_euler_explicit),	intent(inout)		::	self	Integrator.
character(len=*),	intent(in)		::	scheme	Selected scheme.
class(integrand_object),	intent(in),	optional	::	U	Integrand molding prototype.
logical,	intent(in),	optional	::	stop_on_fail	Stop execution if initialization fail.

procedure, public, pass(lhs) :: integr_assign_integr

Operator =.

private subroutine integr_assign_integr(lhs, rhs)

Operator =.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_euler_explicit),	intent(inout)			::	lhs	Left hand side.
class(integrator_object),	intent(in)			::	rhs	Right hand side.

procedure, public, pass(self) :: integrate

Integrate integrand field.

private subroutine integrate(self, U, Dt, t, new_Dt)

Integrate field with explicit Euler scheme, 1st order.

Arguments

Type	Intent	Optional		Name
class(integrator_euler_explicit),	intent(inout)		::	self	Integrator.
class(integrand_object),	intent(inout)		::	U	Field to be integrated.
real(kind=R_P),	intent(in)		::	Dt	Time step.
real(kind=R_P),	intent(in)		::	t	Time.
real(kind=R_P),	intent(out),	optional	::	new_Dt	New adapted time step.

procedure, public, pass(self) :: integrate_fast

Integrate integrand field, fast mode.

private subroutine integrate_fast(self, U, Dt, t, new_Dt)

Integrate field with explicit Euler scheme, 1st order, fast mode.

Arguments

Type	Intent	Optional		Name
class(integrator_euler_explicit),	intent(inout)		::	self	Integrator.
class(integrand_object),	intent(inout)		::	U	Field to be integrated.
real(kind=R_P),	intent(in)		::	Dt	Time step.
real(kind=R_P),	intent(in)		::	t	Time.
real(kind=R_P),	intent(out),	optional	::	new_Dt	New adapted time step.

procedure, public, pass(self) :: is_multistage

Return .true. for multistage integrator.

private elemental function is_multistage(self)

Return .true. for multistage integrator.

Arguments

Type Intent Optional Attributes Name

class(integrator_multistage_object), intent(in) :: self
Integrator.

Return Value logical

Inquire result.

Type	Intent	Optional	Attributes		Name
class(integrator_multistage_object),	intent(in)			::	self	Integrator.

procedure, public, pass(self) :: is_multistep

Return .true. for multistep integrator.

private elemental function is_multistep(self)

Return .true. for multistage integrator.

Arguments

Type Intent Optional Attributes Name

class(integrator_multistage_object), intent(in) :: self
Integrator.

Return Value logical

Inquire result.

Type	Intent	Optional	Attributes		Name
class(integrator_multistage_object),	intent(in)			::	self	Integrator.

procedure, public, pass(self) :: is_supported

Return .true. if the integrator class support the given scheme.

private elemental function is_supported(self, scheme)

Return .true. if the integrator class support the given scheme.

Arguments

Type	Intent	Optional	Attributes		Name
class(integrator_euler_explicit),	intent(in)			::	self	Integrator.
character(len=*),	intent(in)			::	scheme	Selected scheme.

Return Value logical

Inquire result.

procedure, public, pass(self) :: stages_number

Return number of stages used.

private elemental function stages_number(self)

Return number of stages used.

Arguments

Type Intent Optional Attributes Name

class(integrator_multistage_object), intent(in) :: self
Integrator.

Return Value integer(kind=I_P)

Number of stages used.

Type	Intent	Optional	Attributes		Name
class(integrator_multistage_object),	intent(in)			::	self	Integrator.

procedure, public, pass(self) :: steps_number

Return number of steps used.

private elemental function steps_number(self)

Return number of steps used.

Arguments

Type Intent Optional Attributes Name

class(integrator_multistage_object), intent(in) :: self
Integrator.

Return Value integer(kind=I_P)

Number of steps used.

Type	Intent	Optional	Attributes		Name
class(integrator_multistage_object),	intent(in)			::	self	Integrator.

procedure, public, pass(self) :: supported_schemes

Return the list of supported schemes.

private pure function supported_schemes(self) result(schemes)

Return the list of supported schemes.

Arguments

Type Intent Optional Attributes Name

class(integrator_euler_explicit), intent(in) :: self
Integrator.

Return Value character(len=99), allocatable, (:)

Queried scheme.

procedure, public, pass(self) :: trigger_error

Trigger an error.

private subroutine trigger_error(self, error, error_message, is_severe)

Check for error occurencies.

Arguments

Type	Intent	Optional		Name
class(integrator_object),	intent(inout)		::	self	Integrator.
integer(kind=I_P),	intent(in)		::	error	Error status code.
character(len=*),	intent(in),	optional	::	error_message	Error message, hopefully meaningful.
logical,	intent(in),	optional	::	is_severe	Flag to activate severe faliure, namely errors trigger a stop.

Source Code

type, extends(integrator_multistage_object) :: integrator_euler_explicit
  !< FOODIE integrator: provide explicit Euler scheme, it being 1st order accurate.
  contains
    ! deferred methods
    procedure, pass(self) :: class_name           !< Return the class name of schemes.
    procedure, pass(self) :: has_fast_mode        !< Return .true. if the integrator class has *fast mode* integrate.
    procedure, pass(lhs)  :: integr_assign_integr !< Operator `=`.
    procedure, pass(self) :: integrate            !< Integrate integrand field.
    procedure, pass(self) :: integrate_fast       !< Integrate integrand field, fast mode.
    procedure, pass(self) :: is_supported         !< Return .true. if the integrator class support the given scheme.
    procedure, pass(self) :: supported_schemes    !< Return the list of supported schemes.
    ! public methods
    procedure, pass(self) :: destroy    !< Destroy the integrator.
    procedure, pass(self) :: initialize !< Initialize (create) the integrator.
endtype integrator_euler_explicit

integrator_euler_explicit Derived Type

Variables

Type-Bound Procedures

Source Code

All Derived Types

type, public, extends(integrator_multistage_object) :: integrator_euler_explicit

Variables

Type-Bound Procedures

Source Code

Components

Type-Bound Procedures

procedure, public, pass(self) :: allocate_integrand_members

private subroutine allocate_integrand_members(self, U)

Arguments

procedure, public, pass(lhs) :: assign_abstract

private subroutine assign_abstract(lhs, rhs)

Arguments

procedure, public, pass(lhs) :: assign_multistage

private subroutine assign_multistage(lhs, rhs)

Arguments

generic, public :: assignment(=) => integr_assign_integr

private subroutine integr_assign_integr(lhs, rhs)

Arguments

procedure, public, pass(self) :: check_error

private subroutine check_error(self, is_severe)

Arguments

procedure, public, pass(self) :: class_name

private pure function class_name(self)

Arguments

Return Value character(len=99)

procedure, public, pass(self) :: description

private pure function description(self, prefix) result(desc)

Arguments

Return Value character(len=:), allocatable

procedure, public, pass(self) :: destroy

private elemental subroutine destroy(self)

Arguments

procedure, public, pass(self) :: destroy_abstract

private elemental subroutine destroy_abstract(self)

Arguments

procedure, public, pass(self) :: destroy_multistage

private elemental subroutine destroy_multistage(self)

Arguments

procedure, public, pass(self) :: has_fast_mode

private elemental function has_fast_mode(self)

Arguments

Return Value logical

procedure, public, pass(self) :: initialize

private subroutine initialize(self, scheme, U, stop_on_fail)

Arguments

procedure, public, pass(lhs) :: integr_assign_integr

private subroutine integr_assign_integr(lhs, rhs)

Arguments

procedure, public, pass(self) :: integrate

private subroutine integrate(self, U, Dt, t, new_Dt)

Arguments

procedure, public, pass(self) :: integrate_fast

private subroutine integrate_fast(self, U, Dt, t, new_Dt)

Arguments

procedure, public, pass(self) :: is_multistage

private elemental function is_multistage(self)

Arguments

Return Value logical

procedure, public, pass(self) :: is_multistep

private elemental function is_multistep(self)

Arguments

Return Value logical

procedure, public, pass(self) :: is_supported

private elemental function is_supported(self, scheme)

Arguments

Return Value logical

procedure, public, pass(self) :: stages_number

private elemental function stages_number(self)

Arguments

Return Value integer(kind=I_P)

procedure, public, pass(self) :: steps_number

private elemental function steps_number(self)

Arguments

Return Value integer(kind=I_P)

procedure, public, pass(self) :: supported_schemes