ode_solution_mod Module Reference

DERIVED TYPE ode_solution: data straucture to solve ODEs More...

Data Types
interface	clear
interface	ode_Lin_solver
interface	ode_NL_1s_solver
interface	ode_NL_ms_solver
	Abstract interface: multi-step non-linear ODE solver. More...
interface	ode_output_proc
	ode output management More...
interface	ode_solution
	Type ode_solution: data structure to solve ODE/PDE problems. More...
interface	print

Functions/Subroutines
subroutine, public	void_ode_output (tn, s, stop)
	void output for ode resolution More...
subroutine	ode_solution_clear (sol)
	destructor More...
type(ode_solution) function	ode_solution_create (pb, nV, NY, NFY)
	Bottom level constructor for ode_solution. More...
subroutine, public	ode_solution_init_indexes (sol)
	initialise the ode_indexes More...
subroutine	ode_solution_print (sol)
	print ode_solution More...

Detailed Description

DERIVED TYPE ode_solution: data straucture to solve ODEs

An ode_solution contains the data structure to compute solutions of ode_problem relativelly to an ode_solver.

For the construction of ode_solution see ode_solver_mod detailed description.

For the description of ode_problem see ode_problem_mod detailed description.

Let 'sol' of type ode_solution

• sol%Y stores \( Y(x,t) \)
  • it is a 3-dimensional array with shape N x NY x dof
  • NY is the number of instances of Y required by the ode solver (basically 2 for a 2-step solver)
  • when performing the n \(^{\rm th}\) time step:
    \( Y_i(x_k, t_n) = \) sol%Y(i, j, k) with
    • j = 1 for a one-step solver
    • j is a moving index for multistep solvers, j = sol%Y_i(1)
• sol%AY stores \( a(x,t,Y) \)
  • it is a 3-dimensional array with shape Na x NFY x dof
  • when performing the n \(^{\rm th}\) time step:
    \( a_i(x_k, t_n, Y_n) = \) sol%AY(i, j, k) with
    • j = 1 for a one-step solver
    • j is a moving index for multistep solvers, j = sol%FY_i(1)
• sol%BY stores \( b(x,t,Y) \)
  • it is a 3-dimensional array with shape N x NY x dof
  • same management of the second indek as for sol%AY
• sol%V stores \( V(x,t) \)
  • it is a 2-dimensional array with shape dof x NV
  • when performing the n \(^{\rm th}\) time step:
    \( V(x_k, t_n) = \) sol%V(k, j) with
    • j = 1 for a one-step solver
    • j is a moving index for multistep solvers, j = sol%V_i(1)

Author

Charles Pierre

Function/Subroutine Documentation

ode_solution_clear()

subroutine ode_solution_mod::ode_solution_clear ( type(ode_solution), intent(inout)  sol )

private

destructor

Definition at line 226 of file ode_solution_mod.f90.

ode_solution_create()

type(ode_solution) function ode_solution_mod::ode_solution_create ( type(ode_problem), intent(in)  pb, integer, intent(in), optional  nV, integer, intent(in), optional  NY, integer, intent(in), optional  NFY  )

private

Bottom level constructor for ode_solution.

For the user-level constructor see ode_solution_create

Definition at line 258 of file ode_solution_mod.f90.

Here is the call graph for this function:

ode_solution_init_indexes()

subroutine, public ode_solution_mod::ode_solution_init_indexes

(

type(ode_solution), intent(inout)

sol

)

initialise the ode_indexes

Definition at line 316 of file ode_solution_mod.f90.

ode_solution_print()

subroutine ode_solution_mod::ode_solution_print ( type(ode_solution), intent(in)  sol )

private

print ode_solution

Definition at line 344 of file ode_solution_mod.f90.

void_ode_output()

subroutine, public ode_solution_mod::void_ode_output	(	real(rp), intent(in)	tn,
		type(ode_solution), intent(in)	s,
		logical, intent(inout)	stop
	)

void output for ode resolution

Definition at line 215 of file ode_solution_mod.f90.