user_intf Module Reference

Interfaces for user interaction with NEKO.

Data Types
interface	user_final_modules
	Abstract interface for finalizating user variables. More...
interface	user_initialize_modules
	Abstract interface for initilialization of modules. More...
interface	user_material_properties
	Abstract interface for setting material properties. More...
interface	user_simcomp_init
	Abstract interface for adding user defined simulation components. More...
type	user_t
interface	usercheck
	Abstract interface for user defined check functions. More...
interface	useric
	Abstract interface for user defined initial conditions. More...
interface	useric_scalar
	Abstract interface for user defined scalar initial conditions. More...
interface	usermsh
	Abstract interface for user defined mesh deformation functions. More...

Functions/Subroutines
subroutine	user_intf_init (u)
	User interface initialization.
subroutine	dummy_user_ic (u, v, w, p, params)
	Dummy user initial condition.
subroutine	dummy_user_ic_scalar (s, params)
	Dummy user initial condition for scalar field.
subroutine	dummy_user_f_vector (f, t)
	Dummy user (fluid) forcing.
subroutine	dummy_user_f (u, v, w, j, k, l, e, t)
	Dummy user (fluid) forcing.
subroutine	dummy_user_scalar_f_vector (f, t)
	Dummy user (scalar) forcing.
subroutine	dummy_scalar_user_f (s, j, k, l, e, t)
	Dummy user (scalar) forcing.
subroutine	dummy_scalar_user_bc (s, x, y, z, nx, ny, nz, ix, iy, iz, ie, t, tstep)
	Dummy user boundary condition for scalar.
subroutine	dummy_user_mesh_setup (msh)
	Dummy user mesh apply.
subroutine	dummy_user_check (t, tstep, u, v, w, p, coef, params)
	Dummy user check.
subroutine	dummy_user_init_no_modules (t, u, v, w, p, coef, params)
subroutine	dummy_user_init_no_simcomp (params)
subroutine	dummy_user_final_no_modules (t, params)
subroutine	dirichlet_do_nothing (dirichlet_field_list, dirichlet_bc_list, coef, t, tstep, which_solver)
subroutine, public	dummy_user_material_properties (t, tstep, rho, mu, cp, lambda, params)
type(json_file) function, public	simulation_component_user_settings (name, params)
	JSON extraction helper function for simulation components.

Function/Subroutine Documentation

dirichlet_do_nothing()

subroutine user_intf::dirichlet_do_nothing ( type(field_list_t), intent(inout)  dirichlet_field_list, type(bc_list_t), intent(inout)  dirichlet_bc_list, type(coef_t), intent(inout)  coef, real(kind=rp), intent(in)  t, integer, intent(in)  tstep, character(len=*), intent(in)  which_solver  )

private

Definition at line 429 of file user_intf.f90.

Here is the caller graph for this function:

dummy_scalar_user_bc()

subroutine user_intf::dummy_scalar_user_bc ( real(kind=rp), intent(inout)  s, real(kind=rp), intent(in)  x, real(kind=rp), intent(in)  y, real(kind=rp), intent(in)  z, real(kind=rp), intent(in)  nx, real(kind=rp), intent(in)  ny, real(kind=rp), intent(in)  nz, integer, intent(in)  ix, integer, intent(in)  iy, integer, intent(in)  iz, integer, intent(in)  ie, real(kind=rp), intent(in)  t, integer, intent(in)  tstep  )

private

Definition at line 376 of file user_intf.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

dummy_scalar_user_f()

subroutine user_intf::dummy_scalar_user_f ( real(kind=rp), intent(inout)  s, integer, intent(in)  j, integer, intent(in)  k, integer, intent(in)  l, integer, intent(in)  e, real(kind=rp), intent(in)  t  )

private

Definition at line 365 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_check()

subroutine user_intf::dummy_user_check ( real(kind=rp), intent(in)  t, integer, intent(in)  tstep, type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, type(field_t), intent(inout)  p, type(coef_t), intent(inout)  coef, type(json_file), intent(inout)  params  )

private

Definition at line 399 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_f()

subroutine user_intf::dummy_user_f ( real(kind=rp), intent(inout)  u, real(kind=rp), intent(inout)  v, real(kind=rp), intent(inout)  w, integer, intent(in)  j, integer, intent(in)  k, integer, intent(in)  l, integer, intent(in)  e, real(kind=rp), intent(in)  t  )

private

Definition at line 345 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_f_vector()

subroutine user_intf::dummy_user_f_vector ( class(fluid_user_source_term_t), intent(inout)  f, real(kind=rp), intent(in)  t  )

private

Definition at line 338 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_final_no_modules()

subroutine user_intf::dummy_user_final_no_modules ( real(kind=rp)  t, type(json_file), intent(inout)  params  )

private

Definition at line 424 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_ic()

subroutine user_intf::dummy_user_ic ( type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, type(field_t), intent(inout)  p, type(json_file), intent(inout)  params  )

private

Definition at line 319 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_ic_scalar()

subroutine user_intf::dummy_user_ic_scalar ( type(field_t), intent(inout)  s, type(json_file), intent(inout)  params  )

private

Parameters

s	Scalar field.
params	JSON parameters.

Definition at line 331 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_init_no_modules()

subroutine user_intf::dummy_user_init_no_modules ( real(kind=rp)  t, type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, type(field_t), intent(inout)  p, type(coef_t), intent(inout)  coef, type(json_file), intent(inout)  params  )

private

Definition at line 410 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_init_no_simcomp()

subroutine user_intf::dummy_user_init_no_simcomp ( type(json_file), intent(inout)  params )

private

Definition at line 420 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_material_properties()

subroutine, public user_intf::dummy_user_material_properties	(	real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep,
		real(kind=rp), intent(inout)	rho,
		real(kind=rp), intent(inout)	mu,
		real(kind=rp), intent(inout)	cp,
		real(kind=rp), intent(inout)	lambda,
		type(json_file), intent(inout)	params
	)

Definition at line 439 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_mesh_setup()

subroutine user_intf::dummy_user_mesh_setup ( type(mesh_t), intent(inout)  msh )

private

Definition at line 394 of file user_intf.f90.

Here is the caller graph for this function:

dummy_user_scalar_f_vector()

subroutine user_intf::dummy_user_scalar_f_vector ( class(scalar_user_source_term_t), intent(inout)  f, real(kind=rp), intent(in)  t  )

private

Definition at line 358 of file user_intf.f90.

Here is the caller graph for this function:

simulation_component_user_settings()

type(json_file) function, public user_intf::simulation_component_user_settings	(	character(len=*), intent(in)	name,
		type(json_file), intent(inout)	params
	)

Parameters

name	The name of the object to be created.
params	The JSON object containing the user-defined component.

Returns

The JSON object for initializing the simulation component.

Definition at line 454 of file user_intf.f90.

Here is the caller graph for this function:

user_intf_init()

subroutine user_intf::user_intf_init

(

class(user_t), intent(inout)

u

)

Definition at line 185 of file user_intf.f90.

Here is the call graph for this function: