Skip to content

Commit

Permalink
small docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
j-fu committed Nov 22, 2023
1 parent 91fce0d commit c391a27
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions ext/ExtendableGridsGmshExt.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ using UUIDs: uuid1

"""
````
function simplexgrid_from_gmsh(filename::String; incomplete=false, Tc=Float32, Ti=Int32)
simplexgrid_from_gmsh(filename::String; incomplete=false, Tc=Float32, Ti=Int32)
````
The msh file is read and a SimplexGrid is created.
Expand All @@ -39,7 +39,7 @@ end

"""
````
function mixedgrid_from_gmsh(filename::String; Tc=Float32, Ti=Int32)
mixedgrid_from_gmsh(filename::String; Tc=Float32, Ti=Int32)
````
The msh file is read and an ExtendableGrid is created.
Expand Down Expand Up @@ -85,7 +85,7 @@ end

"""
````
function simplexgrid_to_gmsh(g::ExtendableGrid; filename::String="")
simplexgrid_to_gmsh(g::ExtendableGrid; filename::String="")
````
The SimplexGrid 'g' is loaded into a gmsh module.
Expand All @@ -99,7 +99,7 @@ end

"""
````
function mixedgrid_to_gmsh(g::ExtendableGrid; filename::String="")
mixedgrid_to_gmsh(g::ExtendableGrid; filename::String="")
````
The ExtendableGrid 'g' is loaded into a gmsh module.
Expand All @@ -114,7 +114,7 @@ end

"""
````
function gmshfile_to_simplexgrid(filename::String, Tc, Ti)
gmshfile_to_simplexgrid(filename::String, Tc, Ti)
````
This function just reads an msh file, and creates a gmsh.model and then calls the 'mod_to_simplexgrid' function
Expand All @@ -133,7 +133,7 @@ end

"""
````
function gmshfile_to_mixedgrid(filename::String, Tc, Ti)
gmshfile_to_mixedgrid(filename::String, Tc, Ti)
````
This function just reads an msh file, and creates a gmsh.model and then calls the 'mod_to_mixedgrid' function
Expand Down Expand Up @@ -174,7 +174,7 @@ end

"""
````
function mixedgrid_to_gmshfile(grid::ExtendableGrid, filename::String)
mixedgrid_to_gmshfile(grid::ExtendableGrid, filename::String)
````
This function takes a mixed grid, uses 'grid_to_mod' to create a corresponding gmsh module
Expand Down Expand Up @@ -216,7 +216,7 @@ for "grid_to_mod" there also exists "grid_to_gmshfile" which loads the content o

"""
````
function test_gmsh_init()
test_gmsh_init()
````
Very primitive function to test, via a try-catch-block, whether gmsh is already initialized.
Expand All @@ -234,7 +234,7 @@ end

"""
````
function take_second(x)
take_second(x)
````
x is a list of 2-tuples, with an Int as second entry
Expand All @@ -252,7 +252,7 @@ end

"""
````
function multiply_indices(indices, n)
multiply_indices(indices, n)
````
for n=3:
Expand All @@ -273,7 +273,7 @@ end

"""
````
function use_vta(VTA, col_ids, num)
use_vta(VTA, col_ids, num)
````
Expand All @@ -294,7 +294,7 @@ end

"""
````
function use_geoms(cellgeoms, ids)
use_geoms(cellgeoms, ids)
````
If cellgeoms would just be an array/vector, the result would be equivalent to cellgeoms[ids].
Expand All @@ -309,7 +309,7 @@ end

"""
````
function mod_to_grid(model::Module, Tc, Ti)
mod_to_grid(model::Module, Tc, Ti)
````
Function that tries to create an (simplex-) ExtendableGrid from a gmsh.model.
Expand Down Expand Up @@ -426,7 +426,7 @@ end

"""
````
function incomplete_mod_to_simplexgrid(model::Module, Tc, Ti)
incomplete_mod_to_simplexgrid(model::Module, Tc, Ti)
````
Loads an incomplete mesh from a msh file.
Expand Down Expand Up @@ -492,7 +492,7 @@ end

"""
````
function mod_to_mixedgrid(model::Module, Tc, Ti)
mod_to_mixedgrid(model::Module, Tc, Ti)
````
Function that tries to create a (mixed-) ExtendableGrid from a gmsh.model.
Expand Down Expand Up @@ -586,7 +586,7 @@ end

"""
````
function grid_to_mod(grid::ExtendableGrid)
grid_to_mod(grid::ExtendableGrid)
````
This function writes an ExtendableGrid into a gmsh module.
Expand Down

0 comments on commit c391a27

Please sign in to comment.