diff --git a/previews/PR31/.documenter-siteinfo.json b/previews/PR31/.documenter-siteinfo.json index f61e692..99d3c62 100644 --- a/previews/PR31/.documenter-siteinfo.json +++ b/previews/PR31/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-10T18:56:56","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-10T22:10:31","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/previews/PR31/index.html b/previews/PR31/index.html index 4c87806..5c40ea6 100644 --- a/previews/PR31/index.html +++ b/previews/PR31/index.html @@ -1,5 +1,5 @@ -Home · TrixiAtmo.jl
GitHub

TrixiAtmo

Documentation for TrixiAtmo.

TrixiAtmo.P4estMeshCubedSphere2D — Method
P4estMeshCubedSphere2D(trees_per_face_dimension, radius;
+Home · TrixiAtmo.jl
GitHub
TrixiAtmo
Documentation for TrixiAtmo.
TrixiAtmo.P4estMeshCubedSphere2D — Method
P4estMeshCubedSphere2D(trees_per_face_dimension, radius;
                         polydeg, RealT=Float64,
                         initial_refinement_level=0, unsaved_changes=true,
-                        p4est_partition_allow_for_coarsening=true)
Build a "Cubed Sphere" mesh as a 2D P4estMesh with 6 * trees_per_face_dimension^2 trees.
The mesh will have no boundaries.
Arguments
  • trees_per_face_dimension::Integer: the number of trees in the two local dimensions of each face.
  • radius::Integer: the radius of the sphere.
  • polydeg::Integer: polynomial degree used to store the geometry of the mesh. The mapping will be approximated by an interpolation polynomial of the specified degree for each tree.
  • RealT::Type: the type that should be used for coordinates.
  • initial_refinement_level::Integer: refine the mesh uniformly to this level before the simulation starts.
  • unsaved_changes::Bool: if set to true, the mesh will be saved to a mesh file.
  • p4est_partition_allow_for_coarsening::Bool: Must be true when using AMR to make mesh adaptivity independent of domain partitioning. Should be false for static meshes to permit more fine-grained partitioning.
source
TrixiAtmo.examples_dir — Method
examples_dir()
Return the directory where the example files provided with TrixiAtmo.jl are located. If TrixiAtmo.jl is installed as a regular package (with ]add Trixi), these files are read-only and should not be modified. To find out which files are available, use, e.g., readdir:
Examples
readdir(examples_dir())
source

+                        p4est_partition_allow_for_coarsening=true)

Build a "Cubed Sphere" mesh as a 2D P4estMesh with 6 * trees_per_face_dimension^2 trees.

The mesh will have no boundaries.

Arguments

  • trees_per_face_dimension::Integer: the number of trees in the two local dimensions of each face.
  • radius::Integer: the radius of the sphere.
  • polydeg::Integer: polynomial degree used to store the geometry of the mesh. The mapping will be approximated by an interpolation polynomial of the specified degree for each tree.
  • RealT::Type: the type that should be used for coordinates.
  • initial_refinement_level::Integer: refine the mesh uniformly to this level before the simulation starts.
  • unsaved_changes::Bool: if set to true, the mesh will be saved to a mesh file.
  • p4est_partition_allow_for_coarsening::Bool: Must be true when using AMR to make mesh adaptivity independent of domain partitioning. Should be false for static meshes to permit more fine-grained partitioning.
source
TrixiAtmo.examples_dir — Method
examples_dir()

Return the directory where the example files provided with TrixiAtmo.jl are located. If TrixiAtmo.jl is installed as a regular package (with ]add Trixi), these files are read-only and should not be modified. To find out which files are available, use, e.g., readdir:

Examples

readdir(examples_dir())
source