cape.pyover.options.Mesh: OVERFLOW meshing options

This module provides options for OVERFLOW grid systems. OVERFLOW grid systems have a complex file structure, but the pyOver options are relatively simple. First the user specifies either dcf, peg5, or another overall interpolation type using Mesh.get_MeshType(). The user then specifies a home folder for the mesh files. Finally, the user specifies the names of various mesh (and related) files to copy or link (relative to the ConfigDir) into the case folder.

A typical example JSON section is showed below.

"Mesh": {
    "ConfigDir": "common",
    "Type": "dcf",
    "LinkFiles": [
        "grid.in",
        "xrays.in",
        "fomo/grid.ibi",
        "fomo/panel_weights.dat"
    ],
    "CopyFiles": [
        "fomo/mixsur.fmp"
    ]
}
See Also:
class cape.pyover.options.Mesh.Mesh

Dictionary-based interface for OVERFLOW meshing options

get_ConfigDir(config=None)

Get configuration directory containing mesh files

Call:
>>> fdir = opts.get_ConfigDir()
>>> fdir = opts.get_ConfigDir(config)
Inputs:
opts: pyOver.options.Options

Options interface

config: str

Name of configuration to use (optional)

Outputs:
fdir: str

Configuration directory

Versions:

  • 2016-02-02 @ddalle: First version

get_MeshCopyFiles(config=None)

Return the names of mesh files to copy

Call:
>>> fmsh = opts.get_MeshCopyFiles()
Inputs:
opts: pyOver.options.Options

Options interface

config: str

Name of configuration to use (optional)

Outputs:
fmsh: list[str]

List of mesh file names to be copied to each case folder

Versions:

  • 2016-02-01 @ddalle: First version

get_MeshFiles(config=None)

Return the original mesh file names

Call:
>>> fname = opts.get_MeshFiles(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

config: str

Name of configuration to use (optional)

Outputs:
fname: str | list[str]

Mesh file name or list of files

Versions:

  • 2015-12-29 @ddalle: First version

get_MeshLinkFiles(config=None)

Return the names of mesh files to link

Call:
>>> fmsh = opts.get_MeshLinkFiles()
Inputs:
opts: pyOver.options.Options

Options interface

config: str

Name of configuration to use (optional)

Outputs:
fmsh: list[str]

List of mesh file names to be copied to each case folder

Versions:

  • 2016-02-01 @ddalle: First version

get_MeshType(config=None)

Get configuration directory containing mesh files

Call:
>>> ftyp = opts.get_ConfigDir()
>>> ftyp = opts.get_ConfigDir(config)
Inputs:
opts: pyOver.options.Options

Options interface

config: str

Name of configuration to use (optional)

Outputs:

ftyp: str | {dcf} | peg5

Versions:

  • 2016-02-02 @ddalle: First version