scalar_ic::set_scalar_ic Interface Reference

Public Member Functions
subroutine	set_scalar_ic_int (s, coef, gs, type, params, i)
	Set scalar initial condition (builtin)
subroutine	set_scalar_ic_usr (scheme_name, s, coef, gs, user_proc)
	Set scalar intial condition (user defined)

Detailed Description

Definition at line 67 of file scalar_ic.f90.

Member Function/Subroutine Documentation

set_scalar_ic_int()

subroutine scalar_ic::set_scalar_ic::set_scalar_ic_int	(	type(field_t), intent(inout)	s,
		type(coef_t), intent(in)	coef,
		type(gs_t), intent(inout)	gs,
		character(len=*)	type,
		type(json_file), intent(inout)	params,
		integer, intent(in)	i
	)

Set scalar initial condition using one of the builtin types currently supported:

• uniform
• expression
• point zone
• field

  Parameters

  s	Scalar field.
  coef	Coefficient.
  gs	Gather-Scatter object.
  type	Type of initial condition.
  params	JSON parameters.
  i	Index of the scalar field.

Definition at line 88 of file scalar_ic.f90.

Here is the call graph for this function:

set_scalar_ic_usr()

subroutine scalar_ic::set_scalar_ic::set_scalar_ic_usr	(	character(len=*), intent(in)	scheme_name,
		type(field_t), intent(inout), target	s,
		type(coef_t), intent(in)	coef,
		type(gs_t), intent(inout)	gs,
		procedure(user_initial_conditions_intf)	user_proc
	)

Set scalar initial condition using a user defined function.

Parameters

scheme_name	Name of the scheme calling the user routine.
s	Scalar field.
coef	Coefficient.
gs	Gather-Scatter object.
user_proc	User defined initial condition function.

Note

No data is copied between the host and the device. The user routine must leave the values where the backend operates on them, i.e. on the device when running on GPUs.

Definition at line 165 of file scalar_ic.f90.

Here is the call graph for this function:

---

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

• /home/runner/work/neko/neko/src/scalar/scalar_ic.f90