neko_api_user Module Reference

Neko API user callbacks.

Data Types
interface	api_bc_callback
	Abstract interface for boundary condition callbacks. More...
interface	api_ft_callback
	Abstract interface for callbacks requiring a field list and time Used for material properties and source terms. More...
interface	api_gn_callback
	Abstract interface for generic callbacks requiring only time Used for preprocess and compute callbacks. More...
interface	api_ic_callback
	Abstract interface for initial condition callbacks. More...
type	api_user_cb
	Type defining all supported callbacks via the API. More...
interface	neko_api_user_cb_get_field

Functions/Subroutines
subroutine, public	neko_api_user_cb_register (user, initial_cb, preprocess_cb, compute_cb, dirichlet_cb, material_cb, source_cb)
	Register callbacks.
subroutine	neko_api_user_initial_condition (scheme_name, fields)
	API user initial condition callback caller.
subroutine	neko_api_user_preprocess (time)
	API user preprocessing callback caller.
subroutine	neko_api_user_compute (time)
	API user compute callback caller.
subroutine	neko_api_user_dirichlet_condition (fields, bc, time)
	API user dirichlet condition callback caller.
subroutine	neko_api_user_material_properties (scheme_name, properties, time)
	API user material properties callback caller.
subroutine	neko_api_user_source_term (scheme_name, rhs, time)
	API user source term callback caller.
subroutine	neko_api_set_cb_field_list (fields)
	Set the callbacks active field list.
type(field_t) function, pointer	neko_api_user_cb_get_field_by_name (field_name)
	Retrive a pointer to a field for the currently active callback.
type(field_t) function, pointer	neko_api_user_cb_get_field_by_index (field_idx)
	Retrive a pointer to a field for the currently active callback.

Variables
type(api_user_cb), allocatable	neko_api_user_cb
	Registered callbacks in the API.
type(field_list_t), pointer	neko_api_cb_field_list => null()
	Pointer to an active field_list_t in a callback.

Function/Subroutine Documentation

neko_api_set_cb_field_list()

subroutine neko_api_user::neko_api_set_cb_field_list ( type(field_list_t), intent(inout), target  fields )

private

Definition at line 304 of file neko_api_user.f90.

Here is the caller graph for this function:

neko_api_user_cb_get_field_by_index()

type(field_t) function, pointer neko_api_user::neko_api_user_cb_get_field_by_index ( integer, intent(in)  field_idx )

private

Parameters

field_idx

Field index in the field list

Definition at line 329 of file neko_api_user.f90.

neko_api_user_cb_get_field_by_name()

type(field_t) function, pointer neko_api_user::neko_api_user_cb_get_field_by_name ( character(len=*), intent(in)  field_name )

private

Parameters

field_name

Field list entry

Definition at line 315 of file neko_api_user.f90.

neko_api_user_cb_register()

subroutine, public neko_api_user::neko_api_user_cb_register	(	type(user_t), intent(inout)	user,
		type(c_funptr), value	initial_cb,
		type(c_funptr), value	preprocess_cb,
		type(c_funptr), value	compute_cb,
		type(c_funptr), value	dirichlet_cb,
		type(c_funptr), value	material_cb,
		type(c_funptr), value	source_cb
	)

Parameters

user	User interface type
initial_cb	Initial condition callback
preprocess_cb	Pre timestep callback
compute_cb	End of timestep callback
dirichlet_cb	User boundary condition callback
material_cb	Material properties callback
source_cb	Source term callback

Definition at line 123 of file neko_api_user.f90.

Here is the call graph for this function:

neko_api_user_compute()

subroutine neko_api_user::neko_api_user_compute ( type(time_state_t), intent(in)  time )

private

Definition at line 227 of file neko_api_user.f90.

Here is the caller graph for this function:

neko_api_user_dirichlet_condition()

subroutine neko_api_user::neko_api_user_dirichlet_condition ( type(field_list_t), intent(inout)  fields, type(field_dirichlet_t), intent(in)  bc, type(time_state_t), intent(in)  time  )

private

Definition at line 239 of file neko_api_user.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

neko_api_user_initial_condition()

subroutine neko_api_user::neko_api_user_initial_condition ( character(len=*), intent(in)  scheme_name, type(field_list_t), intent(inout)  fields  )

private

Definition at line 202 of file neko_api_user.f90.

Here is the caller graph for this function:

neko_api_user_material_properties()

subroutine neko_api_user::neko_api_user_material_properties ( character(len=*), intent(in)  scheme_name, type(field_list_t), intent(inout)  properties, type(time_state_t), intent(in)  time  )

private

Definition at line 268 of file neko_api_user.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

neko_api_user_preprocess()

subroutine neko_api_user::neko_api_user_preprocess ( type(time_state_t), intent(in)  time )

private

Definition at line 215 of file neko_api_user.f90.

Here is the caller graph for this function:

neko_api_user_source_term()

subroutine neko_api_user::neko_api_user_source_term ( character(len=*), intent(in)  scheme_name, type(field_list_t), intent(inout)  rhs, type(time_state_t), intent(in)  time  )

private

Definition at line 286 of file neko_api_user.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

neko_api_cb_field_list

type(field_list_t), pointer neko_api_user::neko_api_cb_field_list => null()

private

Definition at line 108 of file neko_api_user.f90.

neko_api_user_cb

type(api_user_cb), allocatable neko_api_user::neko_api_user_cb

private

Definition at line 105 of file neko_api_user.f90.