Classes
class	neko_coef_t

class	neko_dofmap_t

class	neko_field_t

class	neko_space_t

Functions
	init ()

	finalize ()

	job_info ()

	case_init (case_json, cb_initial_condition=initial_condition(0), cb_preprocess=preprocess(0), cb_compute=compute(0), cb_dirichlet_condition=dirichlet_condition(0), cb_material_properties=material_properties(0), cb_source_term=source_term(0))

	case_free (case_descr)

	time (case_descr)

	end_time (case_descr)

	tstep (case_descr)

	solve (case_descr)

	step (case_descr)

	field (name)

	field_order (name)

	field_nelements (name)

	field_size (name)

	field_dofmap (name)

	case_fluid_dofmap (case_descr)

	wrap_dofmap (dof_ptr, x_ptr, y_ptr, z_ptr, size)

	field_space (name)

	case_fluid_space (case_descr)

	wrap_space (lx, zg, dr_inv, ds_inv, dt_inv, wx, wy, wz, dx, dy, dz)

	case_fluid_coef (case_descr)

	user_setup (case_descr, cb_initial_condition, cb_preprocess, cb_compute, cb_dirichlet_condition, cb_material_properties, cb_source_term)

	output (case_descr, force=False)

	callback_field (name)

	callback_field_name (index, name)

	bc_mask (msk, msk_size)

	python_str_to_fortran (s)

	python_dict_to_fortran (d)

Variables
	initial_condition = CFUNCTYPE(None, POINTER(c_char_p), c_int)

	preprocess = CFUNCTYPE(None, c_double, c_int)

	compute = CFUNCTYPE(None, c_double, c_int)

	dirichlet_condition = CFUNCTYPE(None, POINTER(c_int), c_int, c_double, c_int)

	material_properties = CFUNCTYPE(None, POINTER(c_char_p), c_int, c_double, c_int)

	source_term = CFUNCTYPE(None, POINTER(c_char_p), c_int, c_double, c_int)

	libneko = CDLL(util.find_library("neko"))

	resType

	argtypes

	restype

Function Documentation

◆ bc_mask()

pyneko.intf.bc_mask	(	msk,
		msk_size
	)

Definition at line 621 of file intf.py.

Here is the call graph for this function:

◆ callback_field()

pyneko.intf.callback_field ( name )

 Retrive a callback's Neko field as a `neko_field_t`.

Definition at line 603 of file intf.py.

Here is the call graph for this function:

◆ callback_field_name()

pyneko.intf.callback_field_name	(	index,
		name
	)

 Check the name of a field at a certain index in the callback's field list.

Definition at line 615 of file intf.py.

Here is the call graph for this function:

◆ case_fluid_coef()

pyneko.intf.case_fluid_coef ( case_descr )

 Retrive coefficients of a Neko case's fluid solver as a `neko_coef_t`.

Definition at line 453 of file intf.py.

Here is the call graph for this function:

◆ case_fluid_dofmap()

pyneko.intf.case_fluid_dofmap ( case_descr )

 Retrive a dofmap of a Neko case's fluid solver as a `neko_dofmap_t`.

Definition at line 349 of file intf.py.

Here is the call graph for this function:

◆ case_fluid_space()

pyneko.intf.case_fluid_space ( case_descr )

 Retrive a space of a Neko case's fluid solver as a `neko_space_t`.

Definition at line 402 of file intf.py.

Here is the call graph for this function:

◆ case_free()

pyneko.intf.case_free ( case_descr )

 Destroy a Neko case.

Definition at line 281 of file intf.py.

Here is the call graph for this function:

◆ case_init()

pyneko.intf.case_init	(	case_json,
		cb_initial_condition = `initial_condition(0)`,
		cb_preprocess = `preprocess(0)`,
		cb_compute = `compute(0)`,
		cb_dirichlet_condition = `dirichlet_condition(0)`,
		cb_material_properties = `material_properties(0)`,
		cb_source_term = `source_term(0)`
	)

Initialise a Neko case

A case is created based on a JSON file and a couple of (optional)
callback functions.

Definition at line 249 of file intf.py.

Here is the call graph for this function:

◆ end_time()

pyneko.intf.end_time ( case_descr )

 Retrive the end time of a case.

Definition at line 290 of file intf.py.

Here is the call graph for this function:

◆ field()

pyneko.intf.field ( name )

 Retrive a Neko field as a `neko_field_t`.

Definition at line 308 of file intf.py.

Here is the call graph for this function:

◆ field_dofmap()

pyneko.intf.field_dofmap ( name )

 Retrive a dofmap of a Neko field as a `neko_dofmap_t`.

Definition at line 335 of file intf.py.

Here is the call graph for this function:

◆ field_nelements()

pyneko.intf.field_nelements ( name )

 Retrive the number of elements in a Neko field.

Definition at line 325 of file intf.py.

Here is the call graph for this function:

◆ field_order()

pyneko.intf.field_order ( name )

 Retrive the order of a Neko field.

Definition at line 320 of file intf.py.

Here is the call graph for this function:

◆ field_size()

pyneko.intf.field_size ( name )

 Retrive the total number of degrees of freedom of a Neko field.

Definition at line 330 of file intf.py.

Here is the call graph for this function:

◆ field_space()

pyneko.intf.field_space ( name )

 Retrive a space of a Neko field as a `neko_space_t`.

Definition at line 378 of file intf.py.

Here is the call graph for this function:

◆ finalize()

pyneko.intf.finalize ( )

 Finalize Neko.

Definition at line 241 of file intf.py.

Here is the call graph for this function:

◆ init()

pyneko.intf.init ( )

 Initialise Neko.

Definition at line 237 of file intf.py.

Here is the call graph for this function:

◆ job_info()

pyneko.intf.job_info ( )

 Display job information.

Definition at line 245 of file intf.py.

Here is the call graph for this function:

◆ output()

pyneko.intf.output	(	case_descr,
		force = `False`
	)

Definition at line 600 of file intf.py.

Here is the call graph for this function:

◆ python_dict_to_fortran()

pyneko.intf.python_dict_to_fortran ( d )

Definition at line 633 of file intf.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ python_str_to_fortran()

pyneko.intf.python_str_to_fortran ( s )

Definition at line 630 of file intf.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solve()

pyneko.intf.solve ( case_descr )

 Solve a Neko case.

Definition at line 300 of file intf.py.

Here is the call graph for this function:

◆ step()

pyneko.intf.step ( case_descr )

 Compute a time-step for a Neko case.

Definition at line 304 of file intf.py.

Here is the call graph for this function:

◆ time()

pyneko.intf.time ( case_descr )

 Retrive the current time of a case.

Definition at line 285 of file intf.py.

Here is the call graph for this function:

◆ tstep()

pyneko.intf.tstep ( case_descr )

 Retrive the current  time-step of a case.

Definition at line 295 of file intf.py.

Here is the call graph for this function:

◆ user_setup()

pyneko.intf.user_setup	(	case_descr,
		cb_initial_condition,
		cb_preprocess,
		cb_compute,
		cb_dirichlet_condition,
		cb_material_properties,
		cb_source_term
	)

 Setup user-provided callbacks.

Definition at line 589 of file intf.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wrap_dofmap()

pyneko.intf.wrap_dofmap	(	dof_ptr,
		x_ptr,
		y_ptr,
		z_ptr,
		size
	)

Definition at line 364 of file intf.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wrap_space()

pyneko.intf.wrap_space	(	lx,
		zg,
		dr_inv,
		ds_inv,
		dt_inv,
		wx,
		wy,
		wz,
		dx,
		dy,
		dz
	)

Definition at line 426 of file intf.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ argtypes

pyneko.intf.argtypes

Definition at line 39 of file intf.py.

◆ compute

pyneko.intf.compute = CFUNCTYPE(None, c_double, c_int)

Definition at line 25 of file intf.py.

◆ dirichlet_condition

pyneko.intf.dirichlet_condition = CFUNCTYPE(None, POINTER(c_int), c_int, c_double, c_int)

Definition at line 27 of file intf.py.

◆ initial_condition

pyneko.intf.initial_condition = CFUNCTYPE(None, POINTER(c_char_p), c_int)

Definition at line 21 of file intf.py.

◆ libneko

pyneko.intf.libneko = CDLL(util.find_library("neko"))

Definition at line 33 of file intf.py.

◆ material_properties

pyneko.intf.material_properties = CFUNCTYPE(None, POINTER(c_char_p), c_int, c_double, c_int)

Definition at line 29 of file intf.py.

◆ preprocess

pyneko.intf.preprocess = CFUNCTYPE(None, c_double, c_int)

Definition at line 23 of file intf.py.

◆ resType

pyneko.intf.resType

Definition at line 35 of file intf.py.

◆ restype

pyneko.intf.restype

Definition at line 40 of file intf.py.

◆ source_term

pyneko.intf.source_term = CFUNCTYPE(None, POINTER(c_char_p), c_int, c_double, c_int)

Definition at line 31 of file intf.py.

Classes

Functions

Variables

Function Documentation

◆ bc_mask()

◆ callback_field()

◆ callback_field_name()

◆ case_fluid_coef()

◆ case_fluid_dofmap()

◆ case_fluid_space()

◆ case_free()

◆ case_init()

◆ end_time()

◆ field()

◆ field_dofmap()

◆ field_nelements()

◆ field_order()

◆ field_size()

◆ field_space()

◆ finalize()

◆ init()

◆ job_info()

◆ output()

◆ python_dict_to_fortran()

◆ python_str_to_fortran()

◆ solve()

◆ step()

◆ time()

◆ tstep()

◆ user_setup()

◆ wrap_dofmap()

◆ wrap_space()

Variable Documentation

◆ argtypes

◆ compute

◆ dirichlet_condition

◆ initial_condition

◆ libneko

◆ material_properties

◆ preprocess

◆ resType

◆ restype

◆ source_term