diff --git a/previews/PR199/c-fortran-api/annotated.html b/previews/PR199/c-fortran-api/annotated.html new file mode 100644 index 00000000..55e8aaf9 --- /dev/null +++ b/previews/PR199/c-fortran-api/annotated.html @@ -0,0 +1,108 @@ + + +
+ + + + +
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+Functions | |
void | trixi_initialize (const char *project_directory, const char *depot_path) |
Initialize Julia runtime environment. More... | |
void | trixi_finalize () |
Finalize Julia runtime environment. More... | |
int | trixi_version_library_major () |
Return major version number of libtrixi. More... | |
int | trixi_version_library_minor () |
Return minor version number of libtrixi. More... | |
int | trixi_version_library_patch () |
Return patch version number of libtrixi. More... | |
const char * | trixi_version_library () |
Return full version string of libtrixi. More... | |
const char * | trixi_version_julia () |
Return name and version of loaded Julia packages LibTrixi directly depends on. More... | |
const char * | trixi_version_julia_extended () |
Return name and version of all loaded Julia packages. More... | |
int | trixi_initialize_simulation (const char *libelixir) |
Set up Trixi simulation. More... | |
int | trixi_is_finished (int handle) |
Check if simulation is finished. More... | |
void | trixi_step (int handle) |
Perform next simulation step. More... | |
void | trixi_finalize_simulation (int handle) |
Finalize simulation. More... | |
double | trixi_calculate_dt (int handle) |
Get time step length. More... | |
int | trixi_ndims (int handle) |
Return number of spatial dimensions. More... | |
int | trixi_nelements (int handle) |
Return number of local elements. More... | |
int | trixi_nelementsglobal (int handle) |
Return global number of elements. More... | |
int | trixi_ndofs (int handle) |
Return number of local degrees of freedom. More... | |
int | trixi_ndofsglobal (int handle) |
Return global number of degrees of freedom. More... | |
int | trixi_ndofselement (int handle) |
Return number of degrees of freedom per element. More... | |
int | trixi_nvariables (int handle) |
Return number of (conservative) variables. More... | |
int | trixi_nnodes (int handle) |
Return number of quadrature nodes per dimension. More... | |
void | trixi_load_node_reference_coordinates (int handle, double *node_coords) |
Get reference coordinates of 1D quadrature nodes. More... | |
void | trixi_load_node_weights (int handle, double *node_weights) |
Get weights of 1D quadrature nodes. More... | |
void | trixi_load_primitive_vars (int handle, int variable_id, double *data) |
Load primitive variable. More... | |
void | trixi_load_element_averaged_primitive_vars (int handle, int variable_id, double *data) |
Load element averages for primitive variable. More... | |
void | trixi_register_data (int handle, int index, int size, const double *data) |
Store data vector in current simulation's registry. More... | |
double | trixi_get_simulation_time (int handle) |
Return current physical time. More... | |
t8_forest_t | trixi_get_t8code_forest (int handle) |
void | trixi_eval_julia (const char *code) |
Execute Julia code. More... | |
anonymous enum | +
+ libtrixi
+
+ |
+
+Modules | |
module | libtrixi |
+Functions/Subroutines | |
subroutine | trixi_initialize (project_directory, depot_path) |
Initialize Julia runtime environment (Fortran convenience version) More... | |
character(len=:) function, allocatable | trixi_version_library () |
Return full version string of libtrixi (Fortran convenience version). More... | |
character(len=:) function, allocatable | trixi_version_julia () |
Return name and version of loaded julia packages LibTrixi directly depends on (Fortran convenience version). More... | |
character(len=:) function, allocatable | trixi_version_julia_extended () |
Return name and version of all loaded julia packages (Fortran convenience version). More... | |
integer(c_int) function | trixi_initialize_simulation (libelixir) |
Set up Trixi simulation (Fortran convencience version) More... | |
logical function | trixi_is_finished (handle) |
Check if simulation is finished (Fortran convenience version) More... | |
subroutine | trixi_eval_julia (code) |
Execute Julia code (Fortran convenience version) More... | |
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+ libtrixi
+
+ |
+
+Typedefs | |
typedef struct t8_forest * | t8_forest_t |
+Functions | |
void | trixi_initialize (const char *project_directory, const char *depot_path) |
Initialize Julia runtime environment. More... | |
void | trixi_finalize () |
Finalize Julia runtime environment. More... | |
int | trixi_version_library_major () |
Return major version number of libtrixi. More... | |
int | trixi_version_library_minor () |
Return minor version number of libtrixi. More... | |
int | trixi_version_library_patch () |
Return patch version number of libtrixi. More... | |
const char * | trixi_version_library () |
Return full version string of libtrixi. More... | |
const char * | trixi_version_julia () |
Return name and version of loaded Julia packages LibTrixi directly depends on. More... | |
const char * | trixi_version_julia_extended () |
Return name and version of all loaded Julia packages. More... | |
int | trixi_initialize_simulation (const char *libelixir) |
Set up Trixi simulation. More... | |
void | trixi_finalize_simulation (int handle) |
Finalize simulation. More... | |
int | trixi_is_finished (int handle) |
Check if simulation is finished. More... | |
void | trixi_step (int handle) |
Perform next simulation step. More... | |
int | trixi_ndims (int handle) |
Return number of spatial dimensions. More... | |
int | trixi_nelements (int handle) |
Return number of local elements. More... | |
int | trixi_nelementsglobal (int handle) |
Return global number of elements. More... | |
int | trixi_ndofs (int handle) |
Return number of local degrees of freedom. More... | |
int | trixi_ndofsglobal (int handle) |
Return global number of degrees of freedom. More... | |
int | trixi_ndofselement (int handle) |
Return number of degrees of freedom per element. More... | |
int | trixi_nvariables (int handle) |
Return number of (conservative) variables. More... | |
int | trixi_nnodes (int handle) |
Return number of quadrature nodes per dimension. More... | |
double | trixi_calculate_dt (int handle) |
Get time step length. More... | |
double | trixi_get_simulation_time (int handle) |
Return current physical time. More... | |
void | trixi_load_node_reference_coordinates (int handle, double *node_coords) |
Get reference coordinates of 1D quadrature nodes. More... | |
void | trixi_load_node_weights (int handle, double *node_weights) |
Get weights of 1D quadrature nodes. More... | |
void | trixi_load_primitive_vars (int handle, int variable_id, double *data) |
Load primitive variable. More... | |
void | trixi_load_element_averaged_primitive_vars (int handle, int variable_id, double *data) |
Load element averages for primitive variable. More... | |
void | trixi_register_data (int handle, int index, int size, const double *data) |
Store data vector in current simulation's registry. More... | |
t8_forest_t | trixi_get_t8code_forest (int handle) |
void | trixi_eval_julia (const char *code) |
Execute Julia code. More... | |
typedef struct t8_forest* t8_forest_t | +
double trixi_calculate_dt | +( | +int | +handle | ) | ++ |
void trixi_eval_julia | +( | +const char * | +code | ) | ++ |
void trixi_finalize | +( | +) | ++ |
void trixi_finalize_simulation | +( | +int | +handle | ) | ++ |
double trixi_get_simulation_time | +( | +int | +handle | ) | ++ |
t8_forest_t trixi_get_t8code_forest | +( | +int | +handle | ) | ++ |
Get t8code forest
+For Trixi simulations on t8code meshes, the t8code forest is returned.
+[in] | handle | simulation handle |
void trixi_initialize | +( | +const char * | +project_directory, | +
+ | + | const char * | +depot_path | +
+ | ) | ++ |
Initialize Julia runtime environment.
+ +Initialize Julia and activate the project at project_directory
. If depot_path
is not a null pointer, forcefully set the environment variable JULIA_DEPOT_PATH
to the value of depot_path
. If depot_path
is null, then proceed as follows: If JULIA_DEPOT_PATH
is already set, do not touch it. Otherwise, set JULIA_DEPOT_PATH
to project_directory
+ default_depot_path
This function must be called before most other libtrixi functions can be used. Libtrixi maybe only be initialized once; subsequent calls to trixi_initialize
are erroneous.
[in] | project_directory | Path to project directory. |
[in] | depot_path | Path to Julia depot path (optional; can be null pointer). |
int trixi_initialize_simulation | +( | +const char * | +libelixir | ) | ++ |
Set up Trixi simulation.
+ +Set up a Trixi simulation by reading the provided libelixir file. It resembles Trixi's typical elixir files with the following differences:
using ...
) has to be inside a function init_simstate()
init
(instead of solve
)SimulationState
has to be created from the semidiscretization and the integrator See the examples in the LibTrixi.jl/examples
folder[in] | libelixir | Path to libelexir file. |
int trixi_is_finished | +( | +int | +handle | ) | ++ |
void trixi_load_element_averaged_primitive_vars | +( | +int | +handle, | +
+ | + | int | +variable_id, | +
+ | + | double * | +data | +
+ | ) | ++ |
Load element averages for primitive variable.
+ +Element averaged values for the primitive variable at position variable_id
for each element are stored in the given array data
.
The given array has to be of correct size (nelements) and memory has to be allocated beforehand.
+[in] | handle | simulation handle |
[in] | variable_id | index of variable |
[out] | data | element averaged values for all elements |
void trixi_load_node_reference_coordinates | +( | +int | +handle, | +
+ | + | double * | +node_coords | +
+ | ) | ++ |
Get reference coordinates of 1D quadrature nodes.
+ +The reference coordinates in [-1,1] of the quadrature nodes in the current DG scheme are stored in the provided array node_coords
. The given array has to be of correct size, i.e. nnodes
, and memory has to be allocated beforehand.
[in] | handle | simulation handle |
[out] | node_coords | node reference coordinates |
void trixi_load_node_weights | +( | +int | +handle, | +
+ | + | double * | +node_weights | +
+ | ) | ++ |
Get weights of 1D quadrature nodes.
+ +The weights of the quadrature nodes in the current DG scheme are stored in the provided array node_weights
. The given array has to be of correct size, i.e. nnodes
, and memory has to be allocated beforehand.
[in] | handle | simulation handle |
[out] | node_weights | node weights |
void trixi_load_primitive_vars | +( | +int | +handle, | +
+ | + | int | +variable_id, | +
+ | + | double * | +data | +
+ | ) | ++ |
Load primitive variable.
+ +The values for the primitive variable at position variable_id
at every degree of freedom are stored in the given array data
.
The given array has to be of correct size (ndofs) and memory has to be allocated beforehand.
+[in] | handle | simulation handle |
[in] | variable_id | index of variable |
[out] | data | values for all degrees of freedom |
int trixi_ndims | +( | +int | +handle | ) | ++ |
int trixi_ndofs | +( | +int | +handle | ) | ++ |
int trixi_ndofselement | +( | +int | +handle | ) | ++ |
int trixi_ndofsglobal | +( | +int | +handle | ) | ++ |
int trixi_nelements | +( | +int | +handle | ) | ++ |
int trixi_nelementsglobal | +( | +int | +handle | ) | ++ |
int trixi_nnodes | +( | +int | +handle | ) | ++ |
int trixi_nvariables | +( | +int | +handle | ) | ++ |
void trixi_register_data | +( | +int | +handle, | +
+ | + | int | +index, | +
+ | + | int | +size, | +
+ | + | const double * | +data | +
+ | ) | ++ |
Store data vector in current simulation's registry.
+ +A reference to the passed data array data
will be stored in the registry of the simulation given by simstate_handle
at given index
. The registry object has to be created in init_simstate()
of the running libelixir and can be used throughout the simulation.
The registry object has to exist, has to be of type LibTrixiDataRegistry
, and has to hold enough data references such that access at index
is valid. Memory storage remains on the user side. It must not be deallocated as long as it might be accessed via the registry. The size of data
has to match size
.
[in] | handle | simulation handle |
[in] | index | index in registry where data vector will be stored |
[in] | size | size of given data vector |
[in] | data | data vector to store |
void trixi_step | +( | +int | +handle | ) | ++ |
const char* trixi_version_julia | +( | +) | ++ |
Return name and version of loaded Julia packages LibTrixi directly depends on.
+ +The return value is a read-only pointer to a NULL-terminated string with the name and version information of the loaded Julia packages, separated by newlines.
+The returned pointer is to static memory and must not be used to change the contents of the version string. Multiple calls to the function will return the same address.
+This function is thread-safe. It must be run after trixi_initialize
has been called.
const char* trixi_version_julia_extended | +( | +) | ++ |
Return name and version of all loaded Julia packages.
+ +The return value is a read-only pointer to a NULL-terminated string with the name and version information of all loaded Julia packages, including implicit dependencies, separated by newlines.
+The returned pointer is to static memory and must not be used to change the contents of the version string. Multiple calls to the function will return the same address.
+This function is thread-safe. It must be run after trixi_initialize
has been called.
const char* trixi_version_library | +( | +) | ++ |
Return full version string of libtrixi.
+ +The return value is a read-only pointer to a NULL-terminated string with the version information. This may include not just MAJOR.MINOR.PATCH but possibly also additional build or development version information.
+The returned pointer is to static memory and must not be used to change the contents of the version string. Multiple calls to the function will return the same address.
+This function is thread-safe and may be run before trixi_initialize
has been called.
int trixi_version_library_major | +( | +) | ++ |
int trixi_version_library_minor | +( | +) | ++ |
+ libtrixi
+
+ |
+
NOTE: It is a known limitation of doxygen that Fortran interfaces will be listed as "Data Types". Please refer to the "Functions/Subroutines" section instead. +More...
++Functions/Subroutines | |
subroutine | trixi_initialize_c (project_directory, depot_path) |
Initialize Julia runtime environment (C char pointer version) More... | |
subroutine | trixi_finalize () |
Finalize Julia runtime environment. More... | |
integer(c_int) function | trixi_version_library_major () |
Return major version number of libtrixi. More... | |
integer(c_int) function | trixi_version_library_minor () |
Return minor version number of libtrixi. More... | |
integer(c_int) function | trixi_version_library_patch () |
Return patch version number of libtrixi. More... | |
type(c_ptr) function | trixi_version_library_c () |
Return full version string of libtrixi (C char pointer version). More... | |
type(c_ptr) function | trixi_version_julia_c () |
Return name and version of loaded julia packages LibTrixi directly depends on (C char pointer version). More... | |
type(c_ptr) function | trixi_version_julia_extended_c () |
Return name and version of all loaded julia packages (C char pointer version). More... | |
integer(c_int) function | trixi_initialize_simulation_c (libelixir) |
Set up Trixi simulation (C char pointer version) More... | |
integer(c_int) function | trixi_is_finished_c (handle) |
Check if simulation is finished (C integer version) More... | |
subroutine | trixi_step (handle) |
Perform next simulation step. More... | |
subroutine | trixi_finalize_simulation (handle) |
Finalize simulation. More... | |
real(c_double) function | trixi_calculate_dt (handle) |
Get time step length. More... | |
integer(c_int) function | trixi_ndims (handle) |
Return number of spatial dimensions. More... | |
integer(c_int) function | trixi_nelements (handle) |
Return number of local elements. More... | |
integer(c_int) function | trixi_nelementsglobal (handle) |
Return global number of elements. More... | |
integer(c_int) function | trixi_ndofs (handle) |
Return number of local degrees of freedom. More... | |
integer(c_int) function | trixi_ndofsglobal (handle) |
Return global number of degrees of freedom. More... | |
integer(c_int) function | trixi_ndofselement (handle) |
Return number of degrees of freedom per element. More... | |
integer(c_int) function | trixi_nvariables (handle) |
Return number of (conservative) variables. More... | |
integer(c_int) function | trixi_nnodes (handle) |
Return number of quadrature nodes per dimension. More... | |
subroutine | trixi_load_node_reference_coordinates (handle, node_coords) |
Get reference coordinates of 1D quadrature nodes. More... | |
subroutine | trixi_load_node_weights (handle, node_weights) |
Get weights of 1D quadrature nodes. More... | |
subroutine | trixi_load_primitive_vars (handle, variable_id, data) |
Load primitive variable. More... | |
real(c_double) function | trixi_get_simulation_time (handle) |
Return current physical time. More... | |
subroutine | trixi_load_element_averaged_primitive_vars (handle, variable_id, data) |
Load element averages for primitive variable. More... | |
subroutine | trixi_register_data (handle, index, size, data) |
Store data vector in current simulation's registry. More... | |
type(c_ptr) function | trixi_get_t8code_forest (handle) |
Get t8code forest. More... | |
subroutine | trixi_eval_julia_c (code) |
Execute Julia code (C char pointer version) More... | |
subroutine | trixi_initialize (project_directory, depot_path) |
Initialize Julia runtime environment (Fortran convenience version) More... | |
character(len=:) function, allocatable | trixi_version_library () |
Return full version string of libtrixi (Fortran convenience version). More... | |
character(len=:) function, allocatable | trixi_version_julia () |
Return name and version of loaded julia packages LibTrixi directly depends on (Fortran convenience version). More... | |
character(len=:) function, allocatable | trixi_version_julia_extended () |
Return name and version of all loaded julia packages (Fortran convenience version). More... | |
integer(c_int) function | trixi_initialize_simulation (libelixir) |
Set up Trixi simulation (Fortran convencience version) More... | |
logical function | trixi_is_finished (handle) |
Check if simulation is finished (Fortran convenience version) More... | |
subroutine | trixi_eval_julia (code) |
Execute Julia code (Fortran convenience version) More... | |
NOTE: It is a known limitation of doxygen that Fortran interfaces will be listed as "Data Types". Please refer to the "Functions/Subroutines" section instead.
+trixi_calculate_dt | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Get time step length.
+[in] | handle | simulation handle |
subroutine libtrixi::trixi_eval_julia | +( | +character(len=*), intent(in) | +code | ) | ++ |
Execute Julia code (Fortran convenience version)
+trixi_eval_julia_c | +( | +character(kind=c_char), dimension(*), intent(in) | +code | ) | ++ |
Execute Julia code (C char pointer version)
+trixi_finalize | +
Finalize Julia runtime environment.
+Clean up internal states. This routine should be executed near the end of the process' lifetime. After the call to trixi_finalize
, no other libtrixi routines may be called anymore, including trixi_finalize
itself.
trixi_finalize_simulation | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Finalize simulation.
+[in] | handle | simulation handle |
trixi_get_simulation_time | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return current physical time.
+[in] | handle | simulation handle |
trixi_get_t8code_forest | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Get t8code forest.
+[in] | handle | simulation handle |
subroutine libtrixi::trixi_initialize | +( | +character(len=*), intent(in) | +project_directory, | +
+ | + | character(len=*), intent(in), optional | +depot_path | +
+ | ) | ++ |
Initialize Julia runtime environment (Fortran convenience version)
+[in] | project_directory | Path to project directory (Fortran string). |
[in] | depot_path | Path to Julia depot path (Fortran string). |
trixi_initialize_c | +( | +character(kind=c_char), dimension(*), intent(in) | +project_directory, | +
+ | + | character(kind=c_char), dimension(*), intent(in), optional | +depot_path | +
+ | ) | ++ |
Initialize Julia runtime environment (C char pointer version)
+Initialize Julia and activate the project at project_directory
. If depot_path
is given, forcefully set the environment variable JULIA_DEPOT_PATH
to the value of depot_path. If
depot_pathis not given, then proceed as follows: If
JULIA_DEPOT_PATHis already set, do not touch it. Otherwise, set
JULIA_DEPOT_PATHto
project_directory+
default_depot_path`.
This routine must be called before most other libtrixi routines can be used. Libtrixi maybe only be initialized once; subsequent calls to trixi_initialize
are erroneous.
[in] | project_directory | Path to project directory (C char pointer) |
[in] | depot_path | Path to Julia depot path (optional, C char pointer) |
integer(c_int) function libtrixi::trixi_initialize_simulation | +( | +character(len=*), intent(in) | +libelixir | ) | ++ |
Set up Trixi simulation (Fortran convencience version)
+[in] | libelixir | Path to libelexir file. |
trixi_initialize_simulation_c | +( | +character(kind=c_char), dimension(*), intent(in) | +libelixir | ) | ++ |
Set up Trixi simulation (C char pointer version)
+[in] | libelixir | Path to libelexir file. |
logical function libtrixi::trixi_is_finished | +( | +integer(c_int), intent(in) | +handle | ) | ++ |
Check if simulation is finished (Fortran convenience version)
+[in] | handle | simulation handle |
trixi_is_finished_c | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Check if simulation is finished (C integer version)
+[in] | handle | simulation handle |
trixi_load_element_averaged_primitive_vars | +( | +integer(c_int), intent(in), value | +handle, | +
+ | + | integer(c_int), intent(in), value | +variable_id, | +
+ | + | real(c_double), dimension(*), intent(out) | +data | +
+ | ) | ++ |
Load element averages for primitive variable.
+[in] | handle | simulation handle |
[in] | variable_id | index of variable |
[out] | data | averaged values for all elements |
trixi_load_node_reference_coordinates | +( | +integer(c_int), intent(in), value | +handle, | +
+ | + | real(c_double), dimension(*), intent(out) | +node_coords | +
+ | ) | ++ |
Get reference coordinates of 1D quadrature nodes.
+The reference coordinates in [-1,1] of the quadrature nodes in the current DG scheme are stored in the provided array node_coords
. The given array has to be of correct size, i.e. nnodes
, and memory has to be allocated beforehand.
[in] | handle | simulation handle |
[out] | node_coords | node reference coordinates |
trixi_load_node_weights | +( | +integer(c_int), intent(in), value | +handle, | +
+ | + | real(c_double), dimension(*), intent(out) | +node_weights | +
+ | ) | ++ |
Get weights of 1D quadrature nodes.
+The weights of the quadrature nodes in the current DG scheme are stored in the provided array node_weights
. The given array has to be of correct size, i.e. nnodes
, and memory has to be allocated beforehand.
[in] | handle | simulation handle |
[out] | node_weights | node weights |
trixi_load_primitive_vars | +( | +integer(c_int), intent(in), value | +handle, | +
+ | + | integer(c_int), intent(in), value | +variable_id, | +
+ | + | real(c_double), dimension(*), intent(out) | +data | +
+ | ) | ++ |
Load primitive variable.
+[in] | handle | simulation handle |
[in] | variable_id | index of variable |
[out] | data | primitive variable values for all degrees of freedom |
trixi_ndims | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return number of spatial dimensions.
+[in] | handle | simulation handle |
trixi_ndofs | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return number of local degrees of freedom.
+[in] | handle | simulation handle |
trixi_ndofselement | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return number of degrees of freedom per element.
+[in] | handle | simulation handle |
trixi_ndofsglobal | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return global number of degrees of freedom.
+[in] | handle | simulation handle |
trixi_nelements | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return number of local elements.
+[in] | handle | simulation handle |
trixi_nelementsglobal | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return global number of elements.
+[in] | handle | simulation handle |
trixi_nnodes | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return number of quadrature nodes per dimension.
+[in] | handle | simulation handle |
trixi_nvariables | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Return number of (conservative) variables.
+[in] | handle | simulation handle |
trixi_register_data | +( | +integer(c_int), intent(in), value | +handle, | +
+ | + | integer(c_int), intent(in), value | +index, | +
+ | + | integer(c_int), intent(in), value | +size, | +
+ | + | real(c_double), dimension(*), intent(in) | +data | +
+ | ) | ++ |
Store data vector in current simulation's registry.
+[in] | handle | simulation handle |
[in] | index | index in registry where data vector will be stored |
[in] | size | size of given data vector |
[in] | data | data vector to store |
trixi_step | +( | +integer(c_int), intent(in), value | +handle | ) | ++ |
Perform next simulation step.
+[in] | handle | simulation handle |
character(len=:) function, allocatable libtrixi::trixi_version_julia | +
Return name and version of loaded julia packages LibTrixi directly depends on (Fortran convenience version).
+trixi_version_julia_c | +
Return name and version of loaded julia packages LibTrixi directly depends on (C char pointer version).
+character(len=:) function, allocatable libtrixi::trixi_version_julia_extended | +
Return name and version of all loaded julia packages (Fortran convenience version).
+trixi_version_julia_extended_c | +
Return name and version of all loaded julia packages (C char pointer version).
+character(len=:) function, allocatable libtrixi::trixi_version_library | +
Return full version string of libtrixi (Fortran convenience version).
+trixi_version_library_c | +
Return full version string of libtrixi (C char pointer version).
+trixi_version_library_major | +
Return major version number of libtrixi.
+trixi_version_library_minor | +
Return minor version number of libtrixi.
+trixi_version_library_patch | +
Return patch version number of libtrixi.
+
+ libtrixi
+
+ |
+
This website documents the C/Fortran API of libtrixi, an interface library for using the Julia package Trixi.jl from C/C++/Fortran.
+You can find the API description separated by programming language:
For information on libtrixi itself, such as installation, usage etc., please refer to the main documentation.
+
+ libtrixi
+
+ |
+
+Public Member Functions | |
real(c_double) function | trixi_calculate_dt (handle) |
Get time step length. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_eval_julia_c (code) |
Execute Julia code (C char pointer version) More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_finalize () |
Finalize Julia runtime environment. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_finalize_simulation (handle) |
Finalize simulation. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
real(c_double) function | trixi_get_simulation_time (handle) |
Return current physical time. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
type(c_ptr) function | trixi_get_t8code_forest (handle) |
Get t8code forest. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_initialize_c (project_directory, depot_path) |
Initialize Julia runtime environment (C char pointer version) More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_initialize_simulation_c (libelixir) |
Set up Trixi simulation (C char pointer version) More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_is_finished_c (handle) |
Check if simulation is finished (C integer version) More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_load_element_averaged_primitive_vars (handle, variable_id, data) |
Load element averages for primitive variable. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_load_node_reference_coordinates (handle, node_coords) |
Get reference coordinates of 1D quadrature nodes. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_load_node_weights (handle, node_weights) |
Get weights of 1D quadrature nodes. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_load_primitive_vars (handle, variable_id, data) |
Load primitive variable. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_ndims (handle) |
Return number of spatial dimensions. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_ndofs (handle) |
Return number of local degrees of freedom. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_ndofselement (handle) |
Return number of degrees of freedom per element. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_ndofsglobal (handle) |
Return global number of degrees of freedom. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_nelements (handle) |
Return number of local elements. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_nelementsglobal (handle) |
Return global number of elements. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_nnodes (handle) |
Return number of quadrature nodes per dimension. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_nvariables (handle) |
Return number of (conservative) variables. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_register_data (handle, index, size, data) |
Store data vector in current simulation's registry. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
subroutine | trixi_step (handle) |
Perform next simulation step. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
type(c_ptr) function | trixi_version_julia_c () |
Return name and version of loaded julia packages LibTrixi directly depends on (C char pointer version). More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
type(c_ptr) function | trixi_version_julia_extended_c () |
Return name and version of all loaded julia packages (C char pointer version). More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
type(c_ptr) function | trixi_version_library_c () |
Return full version string of libtrixi (C char pointer version). More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_version_library_major () |
Return major version number of libtrixi. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_version_library_minor () |
Return minor version number of libtrixi. More... | |
+ libtrixi
+
+ |
+
+Public Member Functions | |
integer(c_int) function | trixi_version_library_patch () |
Return patch version number of libtrixi. More... | |
+ libtrixi
+
+ |
+