refineTriangulation YAML dict options

The YAML file format is used for specifying the information required to run the solver. The documentation below lists the name and type of each option. If an option is flagged as required then it must be included when the parent block is present. The default values and lower/upper bounds are also included for variables that have them. If an option is flagged as mutable then it can be modified on a solver restart. Each tab level in the YAML file should be 2 spaces. Blocks which can take multiple sub-blocks of an entry argument are prefaced by a -. Keywords in the YAML input file are case-insensitive.

interpolate

interpolate:
  sourceGridFile:
  sourceGridFiletype:
  targetVolumeSolutionFile:
  outsideTreatment:
  outsideValue:
  targetVolumeVariableIndex:

• sourceGridFile (string(fileName), default="grid.x")

  • Source grid file whose cell sizes are used to determine an edge length to be targeted during triangulation refinement.

• sourceGridFiletype (string, default="plot3d")

  • Accepted Values: ["plot3d"]
  • Source grid file type.

• targetVolumeSolutionFile (string(fileName), default="sol.q")

  • Volume solution file corresponding to source grid file holding edge length value(s) (e.g., cubeRootCellVolume, minEdgeLength, maxEdgeLength). The selected value is interpolated onto the cell centers of the triangulation and targeted during refinement. Only one type of target solution (surface or volume) may be used at once.

• outsideTreatment (string, default="closest")

  • Accepted Values: ["closest", "fixedvalue"]
  • Values to assign to interpolation point if interpolation stencil is not found.
  • closest: Assigns values based on closest point.
  • fixedValue: Assigns values based on user-specified value.

• outsideValue (float, default=-99.00)

  • User-specified value to fill in interpolation points if interpolation stencil is not found and outsideTreatment is fixedValue.

• targetVolumeVariableIndex (integer, lower bound=1, default=1)

  • Index of variable within target volume solution file that should be targeted during triangulation refinement.

triangulations

triangulations:
  -
    sourceFile: <required>
    sourceFileType:
    outBaseName:
    outFileType:
    outputDir:
    writeFrequency:
    maxRefineIterations:
    targetSurfaceSolutionFile:
    targetSurfaceSolutionFileType:
    targetSurfaceVariableIndex:
    refineRegions:
      -
        components:
        targetEdgeLength:

• Entries in triangulations are defined by a surface triangulation to be refined along with options specifying the refinement.

• sourceFile (string(fileName), required)

  • Source surface triangulation file to be refined.

• sourceFileType (string, default="tri")

  • Accepted Values: ["tri", "cgns"]
  • Source surface triangulation file type.

• outBaseName (string, default="out")

  • The basename for the output surface triangulation file without the file extension. The file extension will be automatically determined based on outFileType.

• outFileType (string, default="tri")

  • Accepted Values: ["tri", "cgns", "tecplot"]
  • Output surface triangulation file type.

• outputDir (string, default="./")

  • Output directory relative to the run directory where the refined triangulations are to be written. A different output directory can be specified for each input triangulation.

• writeFrequency (integer, lower bound=-1, default=0)

  • Controls the frequency of writing refined triangulations. A value of 0 writes only the final refined triangulation. A positive value N writes every Nth intermediate refinement (e.g., 1 writes every step, 2 writes every second step). A value of -1 disables writing altogether.

• maxRefineIterations (integer, lower bound=-1, default=-1)

  • Maximum number of refinement iterations. A value of -1 indicates no maximum. When a source grid file is provided for refinement targeting, the maximum number of iterations corresponds to the maximum number of local refinement iterations between interpolations.

• targetSurfaceSolutionFile (string(fileName), default="surf.q")

  • Target surface solution file holding edge length value(s) (e.g., cubeRootCellVolume, minEdgeLength, maxEdgeLength). The selected value is targeted during refinement. Only one type of target solution (surface or volume) may be used at once.

• targetSurfaceSolutionFileType (string, default=)

  • Accepted Values: ["tri"]
  • Target surface solution file type.

• targetSurfaceVariableIndex (integer, lower bound=1, default=1)

  • Index of variable within target surface solution file that should be targeted during triangulation refinement.

• refineRegions

  • Entries in refineRegions denote specific components or groups of components within a surface triangulation to be refined to a user-specified target edge length.

  • components ([string, ...], default=[""])

    • List of components separated by commas. Components can be specified by number (e.g., 1), number range (e.g., 2-5), or name (e.g., wing).

  • targetEdgeLength (float, lower bound=0.000, default=1.000)

    • Target edge length for component(s).