continuation_scheduler::continuation_scheduler_t Type Reference

Collaboration diagram for continuation_scheduler::continuation_scheduler_t:

Public Member Functions
procedure	init (this, json)
	Initialize the continuation scheduler from JSON defaults.
procedure	free (this)
	free continuation scheduler
procedure	json_get_or_register (this, json, name, target, value, default_value)
	Read a parameter from JSON and optionally register it for continuation. If the parameter is given as a scalar, its value is returned. If it is given as an array, the first entry is used as the initial value and the full array is registered for continuation. If the parameter is not found and no default_value is provided, the routine terminates with an error.
procedure	register_parameter (this, name, target, values, iterations)
	Register a continuation parameter.
procedure	update (this, iter)
	Update all registered parameters for the current iteration.
procedure	get_param_name (this, i)
	Get the name ith param in the scheduler.
procedure	get_n_params (this)
	Get the number of params in the scheduler.

Public Attributes
type(continuation_parameter_t), dimension(:), allocatable	params
integer	default_iterations = 1

Detailed Description

Definition at line 62 of file continuation_scheduler.f90.

Member Function/Subroutine Documentation

free()

procedure continuation_scheduler::continuation_scheduler_t::free

(

class(continuation_scheduler_t), intent(inout)

this

)

Definition at line 67 of file continuation_scheduler.f90.

get_n_params()

procedure continuation_scheduler::continuation_scheduler_t::get_n_params

(

class(continuation_scheduler_t), intent(in)

this

)

Definition at line 72 of file continuation_scheduler.f90.

get_param_name()

procedure continuation_scheduler::continuation_scheduler_t::get_param_name	(	class(continuation_scheduler_t), intent(in)	this,
		integer, intent(in)	i
	)

Definition at line 71 of file continuation_scheduler.f90.

init()

procedure continuation_scheduler::continuation_scheduler_t::init	(	class(continuation_scheduler_t), intent(inout)	this,
		type(json_file), intent(inout)	json
	)

Definition at line 66 of file continuation_scheduler.f90.

json_get_or_register()

procedure continuation_scheduler::continuation_scheduler_t::json_get_or_register	(	class(continuation_scheduler_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		character(len=*), intent(in)	name,
		real(kind=rp), intent(inout), target	target,
		real(kind=rp), intent(out)	value,
		real(kind=rp), intent(in), optional	default_value
	)

Parameters

this	The continuation scheduler instance.
json	The json_file object.
name	The parameter name.
target	Variable that may be registered for continuation.
value	Returned value of the parameter.
default_value	Optional default value if the parameter is not found.

Definition at line 68 of file continuation_scheduler.f90.

register_parameter()

procedure continuation_scheduler::continuation_scheduler_t::register_parameter	(	class(continuation_scheduler_t), intent(inout)	this,
		character(len=*), intent(in)	name,
		real(rp), intent(inout), target	target,
		real(rp), dimension(:), intent(in)	values,
		integer, intent(in), optional	iterations
	)

Definition at line 69 of file continuation_scheduler.f90.

update()

procedure continuation_scheduler::continuation_scheduler_t::update	(	class(continuation_scheduler_t), intent(inout)	this,
		integer, intent(in)	iter
	)

Definition at line 70 of file continuation_scheduler.f90.

Member Data Documentation

default_iterations

integer continuation_scheduler::continuation_scheduler_t::default_iterations = 1

Definition at line 64 of file continuation_scheduler.f90.

params

type(continuation_parameter_t), dimension(:), allocatable continuation_scheduler::continuation_scheduler_t::params

Definition at line 63 of file continuation_scheduler.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/neko-top/neko-top/sources/continuation/continuation_scheduler.f90