libtrixi
Data Types | Functions/Subroutines
Fortran API

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_initialize_simulation_c
 
interface  trixi_calculate_dt
 
interface  trixi_is_finished_c
 
interface  trixi_step
 
interface  trixi_finalize_simulation
 
interface  trixi_finalize
 
interface  julia_eval_string_c
 

Functions/Subroutines

subroutine trixi_initialize_c (project_directory, depot_path)
 Initialize Julia runtime environment (C char pointer version) More...
 
integer(c_int) function trixi_initialize_simulation_c (libelixir)
 Set up Trixi simulation (C char pointer version) More...
 
real(c_double) function trixi_calculate_dt (handle)
 Get time step length. 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...
 
subroutine trixi_finalize ()
 Finalize Julia runtime environment. More...
 
subroutine julia_eval_string_c (code)
 Execute Julia code (C char pointer version) More...
 
logical function trixi_is_finished (handle)
 Check if simulation is finished (Fortran convenience version) More...
 
subroutine trixi_initialize (project_directory, depot_path)
 Initialize Julia runtime environment (Fortran convenience version) More...
 
integer(c_int) function trixi_initialize_simulation (libelixir)
 Set up Trixi simulation (Fortran convencience version) More...
 
subroutine julia_eval_string (code)
 Execute Julia code (Fortran convenience version) More...
 

Detailed Description

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.

Function/Subroutine Documentation

◆ julia_eval_string()

subroutine libtrixi::julia_eval_string ( character(len=*), intent(in)  code)

Execute Julia code (Fortran convenience version)

Warning
Only for development. Code is not checked prior to execution.
See also
julia_eval_string_c (C char pointer version)
julia_eval_string_c (C API)

◆ julia_eval_string_c()

julia_eval_string_c ( character(kind=c_char), dimension(*), intent(in)  code)

Execute Julia code (C char pointer version)

Warning
Only for development. Code is not checked prior to execution.
See also
julia_eval_string_c (Fortran convenience version)
julia_eval_string_c (C API)

◆ trixi_calculate_dt()

trixi_calculate_dt ( integer(c_int), intent(in), value  handle)

Get time step length.

Parameters
[in]handlesimulation handle
Returns
Time step length
See also
trixi_calculate_dt (C API)

◆ trixi_finalize()

Finalize Julia runtime environment.

See also
trixi_finalize (C API)

◆ trixi_finalize_simulation()

trixi_finalize_simulation ( integer(c_int), intent(in), value  handle)

Finalize simulation.

Parameters
[in]handlesimulation handle
See also
trixi_finalize_simulation_api_c "trixi_finalize_simulation (C API)"

◆ trixi_initialize()

subroutine libtrixi::trixi_initialize ( character(len=*), intent(in)  project_directory,
character(len=*), intent(in), optional  depot_path 
)

Initialize Julia runtime environment (Fortran convenience version)

Parameters
[in]project_directoryPath to project directory (Fortran string).
[in]depot_pathPath to Julia depot path (Fortran string).
See also
trixi_initialize_c (C char pointer version)
trixi_initialize (C API)

◆ trixi_initialize_c()

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. Ifdepot_pathis not given, then proceed as follows: If JULIA_DEPOT_PATHis already set, do not touch it. Otherwise, set JULIA_DEPOT_PATHtoproject_directory+default_depot_path`.

Parameters
[in]project_directoryPath to project directory (C char pointer)
[in]depot_pathPath to Julia depot path (optional, C char pointer)
See also
trixi_initialize (Fortran convenience version)
trixi_initialize (C API)

◆ trixi_initialize_simulation()

integer(c_int) function libtrixi::trixi_initialize_simulation ( character(len=*), intent(in)  libelixir)

Set up Trixi simulation (Fortran convencience version)

Parameters
[in]libelixirPath to libelexir file.
Returns
handle (integer) to Trixi simulation instance
See also
trixi_initialize_simulation_c (C char pointer version)
trixi_initialize_simulation (C API)

◆ trixi_initialize_simulation_c()

trixi_initialize_simulation_c ( character(kind=c_char), dimension(*), intent(in)  libelixir)

Set up Trixi simulation (C char pointer version)

Parameters
[in]libelixirPath to libelexir file.
Returns
handle (integer) to Trixi simulation instance
See also
trixi_initialize_simulation (Fortran convenience version)
trixi_initialize_simulation (C API)

◆ trixi_is_finished()

logical function libtrixi::trixi_is_finished ( integer(c_int), intent(in)  handle)

Check if simulation is finished (Fortran convenience version)

Parameters
[in]handlesimulation handle
Returns
true if finished, false if not
See also
trixi_is_finished (C integer version)
trixi_is_finished (C API)

◆ trixi_is_finished_c()

trixi_is_finished_c ( integer(c_int), intent(in), value  handle)

Check if simulation is finished (C integer version)

Parameters
[in]handlesimulation handle
Returns
1 if finished, 0 if not
See also
trixi_is_finished (Fortran convenience version)
trixi_is_finished (C API)

◆ trixi_step()

trixi_step ( integer(c_int), intent(in), value  handle)

Perform next simulation step.

Parameters
[in]handlesimulation handle
See also
trixi_step (C API)