diff --git a/README.md b/README.md index c915782..97de9c6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ \file README.md \author Paul Ullrich -\version August 25, 2015 +\version May 8, 2024 -Copyright 2000-2015 Paul Ullrich +Copyright 2024 Paul Ullrich This file is distributed as part of the Tempest source code package. Permission is granted to use, copy, modify and distribute this @@ -16,7 +16,6 @@ Spherical Quadrilateral Mesh Generator (SQuadGen) REQUIRED EXTERNAL LIBRARIES libpng libnetcdf - libnetcdf_c++ BUILDING Modify src/Makefile to specify NetCDF paths @@ -26,21 +25,30 @@ SYNOPSIS ./SQuadGen PARAMETERS - --grid_type ["CS"] (Options: ICO | CS) + --grid_type ["CS"] (Options: CS | ICO | OCT1 | OCT2) --refine_type ["LOWCONN"] (Options: LOWCONN | CUBIT | LOWCONNOLD) --refine_level [2] --resolution [10] --refine_file [""] - --output ["grid.g"] + --refine_rect [""] + --output [""] --loadcsrefinementmap [false] - --smooth_type ["NONE"] (Options: NONE | SPRING) + --smooth_type ["NONE"] (Options: NONE | SPRING | PRESSURE) --smooth_dist [1] (Smooth distance, -1 = smooth entire mesh) --smooth_iter [10] --lon_base [-180.000000] - --lon_shift [0.000000] + --lat_base [0.000000] + --x_rotate [0.000000] + --y_rotate [0.000000] + --lon_ref [0.000000] + --lat_ref [0.000000] + --orient_ref [0.000000] + --tessellate [0] + --subcellres [0] --invert [false] --block_refine [false] + DESCRIPTION SQuadGen is a mesh generation utility that uses a cubed-sphere base mesh to generate quadrilateral meshes with user-specified enhancements. In order to @@ -63,10 +71,33 @@ OPTIONS a few enhancements over the previous LOWCONN old template by removing spurious elements with high aspect ratios (typically near interior corners). + --refine_level + + Number of levels of refinement to use in grid generation. Each refinement + level corresponds to a 2x refinement of the mesh. + + --resolution + + Base resolution of the mesh. For cubed-sphere meshes this corresponds to the + number of faces along each edge of the cubed-sphere. + --refine_file Filename of the PNG file to use for specifying refinement regions. + --refine_rect + + An argument specifying rectangular regions on the cubed-sphere where + refinement should be applied. Each refine_rect should be separated by a + semi-colon and consists of five arguments: + + ,,,, + + where , are the longitude-latitude coordinates of the lower-right + corner of the refinement region, , are the longitude-latitude + coordinates of the upper-right corner of the refinement region, and + is the number of levels of refinement. + --output Filename for the output EXODUS-format grid file. @@ -102,6 +133,21 @@ OPTIONS Amount of rotation (in degrees) to apply to the base mesh. + --lon_ref + + The central longitude of the first panel of the cubed-sphere (in degrees). + + --lat_ref + + The central latitude of the first panel of the cubed-sphere (in degrees). + + --orient_ref + + The orientation of the cubed sphere at , in degrees. + A value of 0 means the cubed-sphere is aligned perfectly zonal at the\ + reference point. A value of 45 means the cubed-sphere is inclined by 45 + degrees at this point. + --invert Invert the base image (so black identifies regions of refinement).