integrand_tester_object Derived Type

type, public, abstract, extends(integrand_object) :: integrand_tester_object

type~~integrand_tester_object~~InheritsGraph type~integrand_tester_object integrand_tester_object type~integrand_object integrand_object type~integrand_object->type~integrand_tester_object
Help


The abstract tester integrand.

This abstract provided some auxiliary methods useful for the tester machinery.

Inherited By

type~~integrand_tester_object~~InheritedByGraph type~integrand_tester_object integrand_tester_object type~test_object test_object type~integrand_tester_object->type~test_object integrand_0 type~integrand_lcce integrand_lcce type~integrand_tester_object->type~integrand_lcce type~integrand_ladvection integrand_ladvection type~integrand_tester_object->type~integrand_ladvection type~integrand_oscillation integrand_oscillation type~integrand_tester_object->type~integrand_oscillation type~integrand_lcce->type~test_object lcce_0 type~integrand_ladvection->type~test_object ladvection_0 type~integrand_oscillation->type~test_object oscillation_0
Help

Type-Bound Procedures

generic, public :: add_fast => integrand_add_integrand_fast

Overloading add_fast method.

procedure(assignment_integrand), public, deferred, pass(lhs) :: assign_integrand

= operator.

  • subroutine assignment_integrand(lhs, rhs) Prototype

    Symmetric assignment integrand = integrand.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(inout) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

procedure(assignment_real), public, deferred, pass(lhs) :: assign_real

= real operator.

  • pure subroutine assignment_real(lhs, rhs) Prototype

    Symmetric assignment integrand = integrand.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(inout) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

generic, public :: assignment(=) => assign_integrand, assign_real

Overloading = assignament.

  • private pure subroutine assign_integrand(lhs, rhs)

    = operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(inout) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

  • private pure subroutine assign_real(lhs, rhs)

    = real operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(inout) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

procedure(description_interface), public, deferred, pass(self) :: description

Return an informative description of the test.

  • pure function description_interface(self, prefix) result(desc) Prototype

    Return informative integrator description.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_tester_object), intent(in) :: self

    Integrand.

    character(len=*), intent(in), optional :: prefix

    Prefixing string.

    Return Value character(len=:), allocatable

    Description.

procedure(error_interface), public, deferred, pass(self) :: error

Return error.

  • pure function error_interface(self, t, t0, U0) result(error) Prototype

    Return error.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_tester_object), intent(in) :: self

    Integrand.

    real(kind=R_P), intent(in) :: t

    Time.

    real(kind=R_P), intent(in), optional :: t0

    Initial time.

    class(integrand_object), intent(in), optional :: U0

    Initial conditions.

    Return Value real(kind=R_P), allocatable, (:)

    Error.

procedure(exact_solution_interface), public, deferred, pass(self) :: exact_solution

Return exact solution.

  • pure function exact_solution_interface(self, t, t0, U0) result(exact) Prototype

    Return exact solution.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_tester_object), intent(in) :: self

    Integrand.

    real(kind=R_P), intent(in) :: t

    Time.

    real(kind=R_P), intent(in), optional :: t0

    Initial time.

    class(integrand_object), intent(in), optional :: U0

    Initial conditions.

    Return Value real(kind=R_P), allocatable, (:)

    Exact solution.

procedure(export_tecplot_interface), public, deferred, pass(self) :: export_tecplot

Export integrand to Tecplot file.

  • subroutine export_tecplot_interface(self, file_name, t, scheme, close_file, with_exact_solution, U0) Prototype

    Export integrand to Tecplot file.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_tester_object), intent(in) :: self

    Integrand.

    character(len=*), intent(in), optional :: file_name

    File name.

    real(kind=R_P), intent(in), optional :: t

    Time.

    character(len=*), intent(in), optional :: scheme

    Scheme used to integrate integrand.

    logical, intent(in), optional :: close_file

    Flag for closing file.

    logical, intent(in), optional :: with_exact_solution

    Flag for export also exact solution.

    class(integrand_object), intent(in), optional :: U0

    Initial conditions.

procedure(initialize_interface), public, deferred, pass(self) :: initialize

Initialize integrand.

  • subroutine initialize_interface(self, Dt) Prototype

    Initialize integrand.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_tester_object), intent(inout) :: self

    Integrand.

    real(kind=R_P), intent(in) :: Dt

    Time step.

procedure(symmetric_operator), public, deferred, pass(lhs) :: integrand_add_integrand

+ operator.

  • pure function symmetric_operator(lhs, rhs) result(operator_result) Prototype

    Symmetric type operator integrand.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure, public, pass(opr) :: integrand_add_integrand_fast

+ fast operator.

procedure(integrand_op_real), public, deferred, pass(lhs) :: integrand_add_real

+ real operator.

  • pure function integrand_op_real(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator integrand.op.real.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(integrand_dimension_interface), public, deferred, pass(self) :: integrand_dimension

Return integrand dimension.

  • pure function integrand_dimension_interface(self) result(integrand_dimension) Prototype

    Return integrand dimension.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: self

    Integrand.

    Return Value integer(kind=I_P)

    Integrand dimension.

procedure(symmetric_operator), public, deferred, pass(lhs) :: integrand_multiply_integrand

* operator.

  • pure function symmetric_operator(lhs, rhs) result(operator_result) Prototype

    Symmetric type operator integrand.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure, public, pass(opr) :: integrand_multiply_integrand_fast

* fast operator.

procedure(integrand_op_real), public, deferred, pass(lhs) :: integrand_multiply_real

* real operator.

  • pure function integrand_op_real(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator integrand.op.real.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(integrand_op_real_scalar), public, deferred, pass(lhs) :: integrand_multiply_real_scalar

* real_scalar operator.

  • pure function integrand_op_real_scalar(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator integrand.op.real.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure, public, pass(opr) :: integrand_multiply_real_scalar_fast

* real_scalar fast operator.

procedure(symmetric_operator), public, deferred, pass(lhs) :: integrand_sub_integrand

- operator.

  • pure function symmetric_operator(lhs, rhs) result(operator_result) Prototype

    Symmetric type operator integrand.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(integrand_op_real), public, deferred, pass(lhs) :: integrand_sub_real

- real operator.

  • pure function integrand_op_real(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator integrand.op.real.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure, public, pass(opr) :: integrand_subtract_integrand_fast

- fast operator.

procedure(local_error_operator), public, deferred, pass(lhs) :: local_error

||integrand - integrand|| operator.

  • function local_error_operator(lhs, rhs) result(error) Prototype

    Estimate local truncation error between 2 solution approximations.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P)

    Error estimation.

Overloading multiply_fast method.

Overloading * operator.

  • private pure function integrand_multiply_integrand(lhs, rhs) result(opr)

    * operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function integrand_multiply_real(lhs, rhs) result(opr)

    * real_scalar operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function real_multiply_integrand(lhs, rhs) result(opr)

    real_scalar * operator.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs(1:)

    Left hand side.

    class(integrand_oscillation), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function integrand_multiply_real_scalar(lhs, rhs) result(opr)

    * real_scalar operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function real_scalar_multiply_integrand(lhs, rhs) result(opr)

    real_scalar * operator.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs

    Left hand side.

    class(integrand_oscillation), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

Overloading + operator.

  • private pure function integrand_add_integrand(lhs, rhs) result(opr)

    + operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function integrand_add_real(lhs, rhs) result(opr)

    + real operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function real_add_integrand(lhs, rhs) result(opr)

    real + operator.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs(1:)

    Left hand side.

    class(integrand_oscillation), intent(in) :: rhs

    Left hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

Overloading - operator.

  • private pure function integrand_sub_integrand(lhs, rhs) result(opr)

    - operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function integrand_sub_real(lhs, rhs) result(opr)

    - real operator.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    real(kind=R_P), intent(in) :: rhs(1:)

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

  • private pure function real_sub_integrand(lhs, rhs) result(opr)

    real - operator.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs(1:)

    Left hand side.

    class(integrand_oscillation), intent(in) :: rhs

    Left hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

generic, public :: operator(.lterror.) => local_error

Estimate local truncation error.

  • private pure function local_error(lhs, rhs) result(error)

    Estimate local truncation error between 2 oscillation approximations.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_oscillation), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P)

    Error estimation.

procedure(parse_cli_interface), public, deferred, pass(self) :: parse_cli

Initialize from command line interface.

  • subroutine parse_cli_interface(self, cli) Prototype

    Initialize from command line interface.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_tester_object), intent(inout) :: self

    Integrand.

    type(command_line_interface), intent(inout) :: cli

    Command line interface handler.

procedure(real_op_integrand), public, deferred, pass(rhs) :: real_add_integrand

real + operator.

  • pure function real_op_integrand(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator real.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs(1:)

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(real_op_integrand), public, deferred, pass(rhs) :: real_multiply_integrand

real * operator.

  • pure function real_op_integrand(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator real.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs(1:)

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(real_scalar_op_integrand), public, deferred, pass(rhs) :: real_scalar_multiply_integrand

real_scalar * operator.

  • pure function real_scalar_op_integrand(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator real.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(real_op_integrand), public, deferred, pass(rhs) :: real_sub_integrand

real - operator.

  • pure function real_op_integrand(lhs, rhs) result(operator_result) Prototype

    Asymmetric type operator real.op.integrand.

    Arguments

    Type IntentOptional AttributesName
    real(kind=R_P), intent(in) :: lhs(1:)

    Left hand side.

    class(integrand_object), intent(in) :: rhs

    Right hand side.

    Return Value real(kind=R_P), allocatable, (:)

    Operator result.

procedure(set_cli_interface), public, deferred, nopass :: set_cli

Set command line interface.

  • subroutine set_cli_interface(cli) Prototype

    Set command line interface.

    Arguments

    Type IntentOptional AttributesName
    type(command_line_interface), intent(inout) :: cli

    Command line interface handler.

generic, public :: subtract_fast => integrand_subtract_integrand_fast

Overloading subtract_fast method.

procedure(time_derivative), public, deferred, pass(self) :: t

Time derivative, residuals.

  • function time_derivative(self, t) result(dState_dt) Prototype

    Time derivative function of integrand class, i.e. the residuals function.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(in) :: self

    Integrand field.

    real(kind=R_P), intent(in), optional :: t

    Time.

    Return Value real(kind=R_P), allocatable, (:)

    Result of the time derivative function of integrand field.

procedure, public, pass(self) :: t_fast

Time derivative, residuals, fast mode.

  • private subroutine t_fast(self, t)

    Time derivative function of integrand class, i.e. the residuals function. Fast mode acting directly on self.

    Arguments

    Type IntentOptional AttributesName
    class(integrand_object), intent(inout) :: self

    Integrand field.

    real(kind=R_P), intent(in), optional :: t

    Time.

Source Code

type, abstract, extends(integrand_object) :: integrand_tester_object
   !< The abstract tester integrand.
   !<
   !< This abstract provided some auxiliary methods useful for the tester machinery.
   contains
      procedure(description_interface),    pass(self), deferred :: description    !< Return an informative description of the test.
      procedure(error_interface),          pass(self), deferred :: error          !< Return error.
      procedure(exact_solution_interface), pass(self), deferred :: exact_solution !< Return exact solution.
      procedure(export_tecplot_interface), pass(self), deferred :: export_tecplot !< Export integrand to Tecplot file.
      procedure(initialize_interface),     pass(self), deferred :: initialize     !< Initialize integrand.
      procedure(parse_cli_interface),      pass(self), deferred :: parse_cli      !< Initialize from command line interface.
      procedure(set_cli_interface),        nopass,     deferred :: set_cli        !< Set command line interface.
endtype integrand_tester_object