Abstract type of FOODIE ODE integrators of the multistage family.
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. |
Allocate integrand members.
Allocate members of interpolator being of integrand_object class.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(inout) | :: | self | Integrator. |
||
class(integrand_object), | intent(in) | :: | U | Integrand. |
Assign ony members of abstract integrator_object type.
Assign ony members of abstract integrator_object type.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(inout) | :: | lhs | Left hand side. |
||
class(integrator_object), | intent(in) | :: | rhs | Right hand side. |
Assign members of integrator_multistage_object and parents.
Assign members of integrator_multistage_object and parents.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(inout) | :: | lhs | Left hand side. |
||
class(integrator_object), | intent(in) | :: | rhs | Right hand side. |
Overload =
.
Operator =
.
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. |
Check for error occurrencies.
Check for error occurencies.
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. |
Return the class name of schemes.
Return the class name of schemes.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(in) | :: | self | Integrator. |
Class name.
Return informative integrator description.
Return informative integrator description.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(in) | :: | self | Integrator. |
||
character(len=*), | intent(in), | optional | :: | prefix | Prefixing string. |
Description.
Destroy only members of abstract integrator_object type.
Destroy only members of abstract integrator_object type.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(inout) | :: | self | Integrator. |
Destroy the integrator.
Destroy the integrator.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(inout) | :: | self | Integrator. |
Return .true. if the integrator class has fast mode integrate.
Return .true. if the integrator class has fast mode integrate.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(in) | :: | self | Integrator. |
Inquire result.
Operator =
.
Operator =
.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(inout) | :: | lhs | Left hand side. |
||
class(integrator_object), | intent(in) | :: | rhs | Right hand side. |
Integrate integrand field.
Integrate integrand field.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(inout) | :: | self | Integrator. |
||
class(integrand_object), | intent(inout) | :: | U | Integrand. |
||
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. |
Integrate integrand field, fast mode.
Integrate integrand field, fast mode.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | 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. |
Return .true. for multistage integrator.
Return .true. for multistage integrator.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(in) | :: | self | Integrator. |
Inquire result.
Return .true. for multistep integrator.
Return .true. for multistage integrator.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(in) | :: | self | Integrator. |
Inquire result.
Return .true. if the integrator class support the given scheme.
Return .true. if the integrator class support the given scheme.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(in) | :: | self | Integrator. |
||
character(len=*), | intent(in) | :: | scheme | Queried scheme. |
Inquire result.
Return number of stages used.
Return number of stages used.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(in) | :: | self | Integrator. |
Number of stages used.
Return number of steps used.
Return number of steps used.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_multistage_object), | intent(in) | :: | self | Integrator. |
Number of steps used.
Return the list of supported schemes.
Return the list of supported schemes.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(integrator_object), | intent(in) | :: | self | Integrator. |
Queried scheme.
Trigger an error.
Check for error occurencies.
Type | Intent | Optional | Attributes | 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. |
type, extends(integrator_object), abstract :: integrator_multistage_object
!< Abstract type of FOODIE ODE integrators of the multistage family.
integer(I_P) :: registers !< Number of registers used for stages.
integer(I_P) :: stages !< Number of stages.
class(integrand_object), allocatable :: stage(:) !< Stages.
class(integrand_object), allocatable :: buffer !< Buffer used for fast integration.
contains
! deferred methods
procedure(integrate_interface), pass(self), deferred :: integrate !< Integrate integrand field.
procedure(integrate_fast_interface), pass(self), deferred :: integrate_fast !< Integrate integrand field, fast mode.
! implemented deferred methods of parent
procedure, pass(self) :: is_multistage !< Return .true. for multistage integrator.
procedure, pass(self) :: is_multistep !< Return .true. for multistep integrator.
procedure, pass(self) :: stages_number !< Return number of stages used.
procedure, pass(self) :: steps_number !< Return number of steps used.
! public methods
procedure, pass(self) :: allocate_integrand_members !< Allocate integrand members.
procedure, pass(lhs) :: assign_multistage !< Assign members of [[integrator_multistage_object]] and parents.
procedure, pass(self) :: destroy_multistage !< Destroy the integrator.
endtype integrator_multistage_object