neko_api.f90 File Reference

Go to the source code of this file.

Data Types
interface	neko_api::neko_api_user_cb_get_field
	Register callbacks. More...

Modules
module	neko_api
	Neko C API.

Functions/Subroutines
subroutine	neko_api::neko_api_init ()
	Initialise Neko.
subroutine	neko_api::neko_api_finalize ()
	Finalize Neko.
subroutine	neko_api::neko_api_job_info ()
	Display job information.
subroutine	neko_api::neko_api_case_allocate (case_iptr)
	Allocate memory for a Neko case.
subroutine	neko_api::neko_api_case_init (case_json, case_len, case_iptr)
	Initalise a Neko case.
subroutine	neko_api::neko_api_case_free (case_iptr)
	Destroy a Neko case.
real(kind=c_rp) function	neko_api::neko_api_case_time (case_iptr)
	Retrive the current time of a case.
real(kind=c_rp) function	neko_api::neko_api_case_end_time (case_iptr)
	Retrive the end time of a case.
integer(c_int) function	neko_api::neko_api_case_tstep (case_iptr)
	Retrive the time-step of a case.
subroutine	neko_api::neko_api_solve (case_iptr)
	Solve a neko case.
subroutine	neko_api::neko_api_step (case_iptr)
	Compute a time-step for a neko case.
subroutine	neko_api::neko_api_output_ctrl_execute (case_iptr, force_output)
	Execute the Case's output controller.
type(c_ptr) function	neko_api::neko_api_field (field_name)
	Retrive a pointer to a flow field.
integer(c_int) function	neko_api::neko_api_field_order (field_name)
	Retrive the order of a field.
integer(c_int) function	neko_api::neko_api_field_nelements (field_name)
	Retrive the number of elements in a field.
integer(c_int) function	neko_api::neko_api_field_size (field_name)
	Retrive the total number of degrees of freedom of a field.
subroutine	neko_api::neko_api_field_dofmap (field_name, dof_ptr, x_ptr, y_ptr, z_ptr)
	Retrive the dofmap associated with a field.
subroutine	neko_api::neko_api_case_fluid_dofmap (case_iptr, dof_ptr, x_ptr, y_ptr, z_ptr, size)
	Retrive the dofmap associated with a case's fluid solver.
subroutine	neko_api::neko_api_wrap_dofmap (dm, dof_ptr, x_ptr, y_ptr, z_ptr)
	Helper function to assign pointers to a dofmap's data.
subroutine	neko_api::neko_api_field_space (field_name, lx, zg, dr_inv, ds_inv, dt_inv, wx, wy, wz, dx, dy, dz)
	Retrive the space associated with a field.
subroutine	neko_api::neko_api_case_fluid_space (case_iptr, lx, zg, dr_inv, ds_inv, dt_inv, wx, wy, wz, dx, dy, dz)
	Retrive the space associated with a case's fluid solver.
subroutine	neko_api::neko_api_wrap_space (xh, lx, zg, dr_inv, ds_inv, dt_inv, wx, wy, wz, dx, dy, dz)
	Helper function to assign pointers to a space's data.
subroutine	neko_api::neko_api_case_fluid_coef (case_iptr, g11, g22, g33, g12, g13, g23, mult, dxdr, dydr, dzdr, dxds, dyds, dzds, dxdt, dydt, dzdt, drdx, drdy, drdz, dsdx, dsdy, dsdz, dtdx, dtdy, dtdz, jac, b, area, nx, ny, nz)
	Retrive the coefficient associated with a case's fluid solver.
subroutine	neko_api::neko_api_user_setup (case_iptr, initial_cb, preprocess_cb, compute_cb, dirichlet_cb, material_cb, source_cb)
	Setup user-provided callbacks.
type(c_ptr) function	neko_api::neko_api_user_cb_field_by_name (field_name)
	Retrive a pointer to a user callback field.
type(c_ptr) function	neko_api::neko_api_user_cb_field_by_index (field_idx)
	Retrive a pointer to a user callback field.
logical(c_bool) function	neko_api::neko_api_user_cb_field_name_at_index (field_idx, field_name)
	Check if the user callback field at a given index has a given name.