diff --git a/previews/PR128/.documenter-siteinfo.json b/previews/PR128/.documenter-siteinfo.json index 1b1d37b6..690a0d78 100644 --- a/previews/PR128/.documenter-siteinfo.json +++ b/previews/PR128/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-18T16:16:25","documenter_version":"1.1.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-19T07:32:14","documenter_version":"1.1.1"}} \ No newline at end of file diff --git a/previews/PR128/c-fortran-api/annotated.html b/previews/PR128/c-fortran-api/annotated.html deleted file mode 100644 index 741e0385..00000000 --- a/previews/PR128/c-fortran-api/annotated.html +++ /dev/null @@ -1,98 +0,0 @@ - - -
- - - - -
- 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 (cells). More... | |
int | trixi_nelements_global (int handle) |
Return number of global elements (cells). More... | |
int | trixi_nvariables (int handle) |
Return number of (conservative) variables. More... | |
void | trixi_load_cell_averages (double *data, int handle) |
Return cell averaged values. More... | |
t8_forest_t | trixi_get_t8code_forest (int handle) |
void | trixi_eval_julia (const char *code) |
Execute Julia code. More... | |
anonymous enum | -
- libtrixi
-
- |
-
-Data Types | |
interface | trixi_initialize_c |
interface | trixi_finalize |
interface | trixi_version_library_major |
interface | trixi_version_library_minor |
interface | trixi_version_library_patch |
interface | trixi_version_library_c |
interface | trixi_version_julia_c |
interface | trixi_version_julia_extended_c |
interface | trixi_initialize_simulation_c |
interface | trixi_is_finished_c |
interface | trixi_step |
interface | trixi_finalize_simulation |
interface | trixi_calculate_dt |
interface | trixi_ndims |
interface | trixi_nelements |
interface | trixi_nelements_global |
interface | trixi_nvariables |
interface | trixi_load_cell_averages |
interface | trixi_eval_julia_c |
-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 (cells). More... | |
int | trixi_nelements_global (int handle) |
Return number of global elements (cells). More... | |
int | trixi_nvariables (int handle) |
Return number of (conservative) variables. More... | |
double | trixi_calculate_dt (int handle) |
Get time step length. More... | |
void | trixi_load_cell_averages (double *data, int handle) |
Return cell averaged values. 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 | ) | -- |
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_cell_averages | -( | -double * | -data, | -
- | - | int | -handle | -
- | ) | -- |
Return cell averaged values.
- -Cell averaged values for each cell and each primitive variable are stored in a contiguous array, where cell values for the first variable appear first and values for the other variables subsequently (structure-of-arrays layout).
-The given array has to be of correct size and memory has to be allocated beforehand.
-[in] | handle | simulation handle |
[out] | data | cell averaged values for all cells and all primitive variables |
int trixi_ndims | -( | -int | -handle | ) | -- |
int trixi_nelements | -( | -int | -handle | ) | -- |
int trixi_nelements_global | -( | -int | -handle | ) | -- |
int trixi_nvariables | -( | -int | -handle | ) | -- |
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...
--Data Types | |
interface | trixi_initialize_c |
interface | trixi_finalize |
interface | trixi_version_library_major |
interface | trixi_version_library_minor |
interface | trixi_version_library_patch |
interface | trixi_version_library_c |
interface | trixi_version_julia_c |
interface | trixi_version_julia_extended_c |
interface | trixi_initialize_simulation_c |
interface | trixi_is_finished_c |
interface | trixi_step |
interface | trixi_finalize_simulation |
interface | trixi_calculate_dt |
interface | trixi_ndims |
interface | trixi_nelements |
interface | trixi_nelements_global |
interface | trixi_nvariables |
interface | trixi_load_cell_averages |
interface | trixi_eval_julia_c |
-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 (cells) More... | |
integer(c_int) function | trixi_nelements_global (handle) |
Return number of global elements (cells) More... | |
integer(c_int) function | trixi_nvariables (handle) |
Return number of (conservative) variables. More... | |
subroutine | trixi_load_cell_averages (data, handle) |
Return cell averaged values. 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 |
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_cell_averages | -( | -real(c_double), dimension(*), intent(in) | -data, | -
- | - | integer(c_int), intent(in), value | -handle | -
- | ) | -- |
Return cell averaged values.
-[in] | handle | simulation handle |
[out] | data | cell averaged values for all cells and all variables |
trixi_ndims | -( | -integer(c_int), intent(in), value | -handle | ) | -- |
Return number of spatial dimensions.
-[in] | handle | simulation handle |
trixi_nelements | -( | -integer(c_int), intent(in), value | -handle | ) | -- |
Return number of local elements (cells)
-[in] | handle | simulation handle |
trixi_nelements_global | -( | -integer(c_int), intent(in), value | -handle | ) | -- |
Return number of global elements (cells)
-[in] | handle | simulation handle |
trixi_nvariables | -( | -integer(c_int), intent(in), value | -handle | ) | -- |
Return number of (conservative) variables.
-[in] | handle | simulation handle |
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 | |
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_cell_averages (data, handle) |
Return cell averaged values. 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_nelements (handle) |
Return number of local elements (cells) More... | |
- libtrixi
-
- |
-
-Public Member Functions | |
integer(c_int) function | trixi_nelements_global (handle) |
Return number of global elements (cells) More... | |
- libtrixi
-
- |
-
-Public Member Functions | |
integer(c_int) function | trixi_nvariables (handle) |
Return number of (conservative) variables. 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
-
- |
-