Type to manage multiple scalar transport equations. More...

Collaboration diagram for scalars::scalars_t:

Public Member Functions
generic	init (this, n_scalars, msh, coef, gs, params, numerics_params, user, chkp, ulag, vlag, wlag, time_scheme, rho)
	Initialize the scalars container.

generic	init (this, msh, coef, gs, params, numerics_params, user, chkp, ulag, vlag, wlag, time_scheme, rho)
	Initialize the scalars container.

procedure	step (this, time, ext_bdf, dt_controller)
	Perform a time step for all scalar fields.

procedure	restart (this, chkp)
	Restart from checkpoint data.

procedure	set_initial_conditions (this, user, is_restart)
	Set initial conditions for all scalar fields.

procedure	validate (this)
	Check if the configuration is valid.

procedure	free (this)
	Clean up all resources.

Public Attributes
type(scalar_scheme_wrapper_t), dimension(:), allocatable	scalar_fields
	The scalar fields.

class(ksp_t), allocatable	shared_ksp
	Shared KSP solver for all scalar fields.

Private Member Functions
procedure, private	scalars_init (this, n_scalars, msh, coef, gs, params, numerics_params, user, chkp, ulag, vlag, wlag, time_scheme, rho)
	Initialize the scalars container.

procedure, private	scalars_init_single (this, msh, coef, gs, params, numerics_params, user, chkp, ulag, vlag, wlag, time_scheme, rho)

Detailed Description

Definition at line 60 of file scalars.f90.

Member Function/Subroutine Documentation

◆ free()

procedure scalars::scalars_t::free ( class(scalars_t), intent(inout) this )

Definition at line 79 of file scalars.f90.

◆ init() [1/2]

generic scalars::scalars_t::init	(	class(scalars_t), intent(inout)	this,
		type(mesh_t), intent(in), target	msh,
		type(coef_t), intent(in), target	coef,
		type(gs_t), intent(inout), target	gs,
		type(json_file), intent(inout), target	params,
		type(json_file), intent(inout), target	numerics_params,
		type(user_t), intent(in), target	user,
		type(chkp_t), intent(inout), target	chkp,
		type(field_series_t), intent(in), target	ulag,
		type(field_series_t), intent(in), target	vlag,
		type(field_series_t), intent(in), target	wlag,
		type(time_scheme_controller_t), intent(in), target	time_scheme,
		type(field_t), intent(in), target	rho
	)

Definition at line 67 of file scalars.f90.

◆ init() [2/2]

generic scalars::scalars_t::init	(	class(scalars_t), intent(inout)	this,
		integer, intent(in)	n_scalars,
		type(mesh_t), intent(in), target	msh,
		type(coef_t), intent(in), target	coef,
		type(gs_t), intent(inout), target	gs,
		type(json_file), intent(inout), target	params,
		type(json_file), intent(inout), target	numerics_params,
		type(user_t), intent(in), target	user,
		type(chkp_t), intent(inout), target	chkp,
		type(field_series_t), intent(in), target	ulag,
		type(field_series_t), intent(in), target	vlag,
		type(field_series_t), intent(in), target	wlag,
		type(time_scheme_controller_t), intent(in), target	time_scheme,
		type(field_t), intent(in), target	rho
	)

Definition at line 67 of file scalars.f90.

Here is the call graph for this function:

◆ restart()

procedure scalars::scalars_t::restart	(	class(scalars_t), intent(inout)	this,
		type(chkp_t), intent(inout)	chkp
	)

Definition at line 73 of file scalars.f90.

◆ scalars_init()

procedure, private scalars::scalars_t::scalars_init	(	class(scalars_t), intent(inout)	this,
		integer, intent(in)	n_scalars,
		type(mesh_t), intent(in), target	msh,
		type(coef_t), intent(in), target	coef,
		type(gs_t), intent(inout), target	gs,
		type(json_file), intent(inout), target	params,
		type(json_file), intent(inout), target	numerics_params,
		type(user_t), intent(in), target	user,
		type(chkp_t), intent(inout), target	chkp,
		type(field_series_t), intent(in), target	ulag,
		type(field_series_t), intent(in), target	vlag,
		type(field_series_t), intent(in), target	wlag,
		type(time_scheme_controller_t), intent(in), target	time_scheme,
		type(field_t), intent(in), target	rho
	)

private

Definition at line 68 of file scalars.f90.

◆ scalars_init_single()

procedure, private scalars::scalars_t::scalars_init_single	(	class(scalars_t), intent(inout)	this,
		type(mesh_t), intent(in), target	msh,
		type(coef_t), intent(in), target	coef,
		type(gs_t), intent(inout), target	gs,
		type(json_file), intent(inout), target	params,
		type(json_file), intent(inout), target	numerics_params,
		type(user_t), intent(in), target	user,
		type(chkp_t), intent(inout), target	chkp,
		type(field_series_t), intent(in), target	ulag,
		type(field_series_t), intent(in), target	vlag,
		type(field_series_t), intent(in), target	wlag,
		type(time_scheme_controller_t), intent(in), target	time_scheme,
		type(field_t), intent(in), target	rho
	)

private

Definition at line 69 of file scalars.f90.

◆ set_initial_conditions()

procedure scalars::scalars_t::set_initial_conditions	(	class(scalars_t), intent(inout)	this,
		type(user_t), intent(in)	user,
		logical, intent(in)	is_restart
	)

Parameters

user	Type with user-defined procedures.
is_restart	Whether the case is restarting from a checkpoint.

Definition at line 75 of file scalars.f90.

◆ step()

procedure scalars::scalars_t::step	(	class(scalars_t), intent(inout)	this,
		type(time_state_t), intent(in)	time,
		type(time_scheme_controller_t), intent(inout)	ext_bdf,
		type(time_step_controller_t), intent(inout)	dt_controller
	)

Definition at line 71 of file scalars.f90.

◆ validate()

procedure scalars::scalars_t::validate ( class(scalars_t), intent(inout) this )

Definition at line 77 of file scalars.f90.

Member Data Documentation

◆ scalar_fields

type(scalar_scheme_wrapper_t), dimension(:), allocatable scalars::scalars_t::scalar_fields

Definition at line 62 of file scalars.f90.

◆ shared_ksp

class(ksp_t), allocatable scalars::scalars_t::shared_ksp

Definition at line 64 of file scalars.f90.

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

/home/runner/work/neko/neko/src/scalar/scalars.f90

Public Member Functions

Public Attributes

Private Member Functions