cvode_integrator_procedures Submodule

Contains module procedures associated with the CVODE integrator class

Uses

- Ancestors:
- cvode_integrator_class

Module Subroutines

module subroutine integrateCVODE(this, manipulatedModeller, outputVars, inputVars)

Implementation of abstract manipulate routine for the case of Runge-Kutta integrator

Arguments

Type	Intent	Optional	Attributes		Name
class(CVODEIntegrator),	intent(inout)			::	this
class(ModellerSurrogate),	intent(inout)			::	manipulatedModeller	Modeller to be used in callbacks during integration
class(VariableContainer),	intent(inout)			::	outputVars	VariableContainer object to store the integration output
class(VariableContainer),	intent(in)			::	inputVars	VariableContainer object housing input data for the integration routine

module subroutine initCVODEIntegrator(this, mpiCont, options, modelList, termGroups, evolvesTimeVar, dtController, initialTimestep, integratorName)

Arguments

Type	Intent	Optional	Attributes		Name
class(CVODEIntegrator),	intent(inout)			::	this
type(MPIController),	intent(in)			::	mpiCont	MPI Controller used to initialise the sundials context
type(CVODEOptions),	intent(in)			::	options	Options object containing CVODE options
integer(kind=ik),	intent(in),	optional,	dimension(:)	::	modelList	List of models this integrator will be responsible for
type(IntArray),	intent(in),	optional,	dimension(:)	::	termGroups	Term groups this integrator is responsible for - should conform with modelList
logical,	intent(in),	optional		::	evolvesTimeVar	Set to true if this integrator is allowed to change the "time" varible (if present in passed variable container)
class(TimestepController),	intent(in),	optional		::	dtController	User-supplied timestep controller object
real(kind=rk),	intent(in),	optional		::	initialTimestep	Default timestep
character(len=*),	intent(in),	optional		::	integratorName	Name of integrator used in printing

impure elemental module subroutine finalizeCVODEIntegrator(this)

Arguments

Type	Intent	Optional	Attributes		Name
type(CVODEIntegrator),	intent(inout)			::	this