FastIce.jl
Documentation for FastIce.jl
Information about the STREAM project can be found in the GPU4GEO website
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 54a2d23d..592212f3 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-04T08:43:50","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-04T08:46:39","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index a781b862..5e6fcdf6 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -
Documentation for FastIce.jl
Information about the STREAM project can be found in the GPU4GEO website
Settings
This document was generated with Documenter.jl version 1.7.0 on Wednesday 4 September 2024. Using Julia version 1.10.5.
Documentation for FastIce.jl
Information about the STREAM project can be found in the GPU4GEO website
Settings
This document was generated with Documenter.jl version 1.7.0 on Wednesday 4 September 2024. Using Julia version 1.10.5.
FastIce.Writers.write_h5
— Methodwrite_h5(arch, grid, path, fields)
Write output fields
in HDF5 format to a file on path
for global grid
.
FastIce.Writers.write_xdmf
— Functionwrite_xdmf(arch, grid, path, fields, h5_names, timesteps=Float64(0.0))
Write Xdmf metadata to path
for corresponding h5_names
and fields
for global grid
. Saving time-dependant data can be achieved upon passing a vector to h5_names
and timesteps
.
FastIce.LevelSets.compute_levelset_from_dem!
— Functioncompute_levelset_from_dem!(arch::Architecture, launch, Ψ::Field, dem::AbstractField, dem_grid2D::UniformGrid, grid::UniformGrid, R=LinearAlgebra.I)
Compute level sets from dem.
FastIce.LevelSets.invert_levelset!
— Methodinvert_levelset!(arch::Architecture, launch, Ψ::Field, grid::UniformGrid)
Invert level set Ψ
to set what's below the surface as "inside".
Settings
This document was generated with Documenter.jl version 1.7.0 on Wednesday 4 September 2024. Using Julia version 1.10.5.
FastIce.Writers.write_h5
— Methodwrite_h5(arch, grid, path, fields)
Write output fields
in HDF5 format to a file on path
for global grid
.
FastIce.Writers.write_xdmf
— Functionwrite_xdmf(arch, grid, path, fields, h5_names, timesteps=Float64(0.0))
Write Xdmf metadata to path
for corresponding h5_names
and fields
for global grid
. Saving time-dependant data can be achieved upon passing a vector to h5_names
and timesteps
.
FastIce.LevelSets.compute_levelset_from_dem!
— Functioncompute_levelset_from_dem!(arch::Architecture, launch, Ψ::Field, dem::AbstractField, dem_grid2D::UniformGrid, grid::UniformGrid, R=LinearAlgebra.I)
Compute level sets from dem.
FastIce.LevelSets.invert_levelset!
— Methodinvert_levelset!(arch::Architecture, launch, Ψ::Field, grid::UniformGrid)
Invert level set Ψ
to set what's below the surface as "inside".
Settings
This document was generated with Documenter.jl version 1.7.0 on Wednesday 4 September 2024. Using Julia version 1.10.5.
To run the FastIce test suite on the CPU, simple run test
from within the package mode or using Pkg
:
julia> using Pkg
julia> Pkg.test("FastIce")
To run the FastIce test suite on CUDA or ROC backend (Nvidia or AMD GPUs), respectively, run the tests using Pkg
adding following test_args
:
julia> using Pkg
julia> Pkg.test("FastIce"; test_args=["--backend=CUDA"])
julia> using Pkg
-julia> Pkg.test("FastIce"; test_args=["--backend=AMDGPU"])
Settings
This document was generated with Documenter.jl version 1.7.0 on Wednesday 4 September 2024. Using Julia version 1.10.5.
Settings
This document was generated with Documenter.jl version 1.7.0 on Wednesday 4 September 2024. Using Julia version 1.10.5.