streamline GridSpec_ones a bit, add docs, fix GridLoad_default

Author: gaelforget

src/ReadWrite.jl

@@ -267,4 +267,4 @@ function write_tiles(fil::String,x::AbstractMeshArray)
   close(fid)
 end
 
-##
+##

src/grids/main.jl

@@ -20,14 +20,14 @@ function GridSpec(category="default",
         GridSpec_default(ID=ID)
     elseif category=="ones"&&ID==:unknown
         npoints=(isnothing(np) ? 10 : np)
-        GridSpec_ones("PeriodicDomain",1,npoints)
+        GridSpec_ones("PeriodicDomain",nP=npoints)
     else
         GridSpec_MITgcm(category, path; np=np, ID=ID)
     end
 end
 
 """
-    GridSpec_default(xy=NamedTuple(), nFaces=1; ID=:unknown)
+    GridSpec_default(xy=NamedTuple(); ID=:unknown, ioPrec=Float64, tile=[])
 
 - Select one of the pre-defined grids 
     - or by providing `xy` parameter (a `NamedTuple` that includes `:xc, :yc, :xg, :yg`)
@@ -304,19 +304,18 @@ import .NEMO_GRID: GridLoad_NEMO, GridSpec_NEMO
 MeshArrays.GridSpec_default(ID=:IAP)
 ```
 """
-function GridLoad_default(gr=GridSpec())
-    xy=(if gr.path=="_default_IAP"
+function GridLoad_default(γ=GridSpec())
+    xy=(if γ.path=="_default_IAP"
             Grids_simple.xy_IAP()
-        elseif gr.path=="_default_Oscar"
+        elseif γ.path=="_default_Oscar"
             Grids_simple.xy_Oscar()
-        elseif gr.path=="_default_OISST"
+        elseif γ.path=="_default_OISST"
             Grids_simple.xy_OISST()
         else
             error("unknown grid ID")
         end)
-    (ni,nj)=(length(xy.xc),length(xy.yc)) #still needs fixing ... set according to gr ...
-    gr=Grids_simple.grid_factors(xy,tile=(ni,nj))
-    dep=[10 100 1000]; msk=ones(gr[:XC].fSize[1]...,3)
+    gr=Grids_simple.grid_factors(xy,tile=γ.fSize[1])
+    dep=[10 100 1000]; msk=ones(γ.ioSize...,3)
     gr=Grids_simple.grid_add_z(gr,dep,msk)
 end
 

src/grids/simple.jl

@@ -6,33 +6,35 @@ import MeshArrays: gcmgrid, varmeta, MeshArray, Dict_to_NamedTuple
 import MeshArrays: read_tiles, write_tiles, GridSpec_default
 
 """
-    GridSpec_ones(grTp,nF,nP)
+    GridSpec_ones(grTp; ioPrec=Float64,nP=10,nF=1)
 
-Define grid where all variables will be set 
-to one via `GridLoad_ones`.
+Define grid where all variables will be set to one via `GridLoad_ones`.
+
+- Possible values for `grTp`` : "LatLonCap","CubeSphere","PeriodicChannel","PeriodicDomain".
+- `nP` : number of points at each subdomain edge.
+- `nF` (only for "PeriodicChannel", "PeriodicDomain" grids) : number of subdomains.
 
 ```
 using MeshArrays
-γ=MeshArrays.GridSpec_ones("CubeSphere",6,20);
+γ=MeshArrays.GridSpec_ones("CubeSphere")
 Γ=MeshArrays.GridLoad_ones(γ;option="full")
 ```
 """
-function GridSpec_ones(grTp,nF,nP; ioPrec=Float64)
+function GridSpec_ones(grTp; ioPrec=Float64,nP=10,nF=1)
     grDir="_ones"
     grTopo=grTp
-    nFaces=nF
     if grTopo=="LatLonCap"
-        ioSize=[nP nP*nF]
+        nFaces=5
     elseif grTopo=="CubeSphere"
-        ioSize=[nP nP*nF]
+        nFaces=6
     elseif grTopo=="PeriodicChannel"
-        ioSize=[nP nP]
+        nFaces=nF
     elseif grTopo=="PeriodicDomain"
-        nFsqrt=Int(sqrt(nF))
-        ioSize=[nP*nFsqrt nP*nFsqrt]
+        nFaces=nF
     else
         error("unknown configuration (grTopo)")
     end
+    ioSize=[nP nP*nFaces]
     facesSize=Array{NTuple{2, Int},1}(undef,nFaces)
     facesSize[:].=[(nP,nP)]
 
@@ -154,12 +156,11 @@ isa(Γ.XC,MeshArray)
 
 true
 ```
-
 """
 function periodic_domain(np::Integer,nq=missing)
     ismissing(nq) ? nq=np : nothing
 
-    nFaces=1 #still needs fixing ...
+    nFaces=1
     ioSize=[np nq]
     facesSize=Array{NTuple{2, Int},1}(undef,nFaces)
     facesSize[:].=[(np,nq)]

test/runtests.jl

@@ -22,7 +22,7 @@ include(joinpath(p,"../examples/Demos.jl"))
         elseif nTopo==4; grTopo="PeriodicDomain"; nFaces=1; N=400;
         end;
         Npt=nFaces*N*N
-        γ=MeshArrays.GridSpec_ones(grTopo,nFaces,N)
+        γ=MeshArrays.GridSpec_ones(grTopo,nP=N)
         Γ=MeshArrays.GridLoad_ones(γ;option="full")
         @test γ.class == grTopo
         Rini= 0.; Rend= 0.;
@@ -239,7 +239,7 @@ end
     (Γ,γ)=Grids_simple.UnitGrid( (80,90) , (20,30) ; option="full")
     @test isa(γ,gcmgrid)
 
-    γ=Grids_simple.GridSpec_ones("PeriodicDomain",1,10)
+    γ=Grids_simple.GridSpec_ones("PeriodicDomain",nP=10)
     Γ=Grids_simple.GridLoad_ones(γ,option="full")
     @test isa(Γ,NamedTuple)