postprocessing.paraview.slices

Functions

`slices_cp_cmd`()	Wrapper around the slices_cp() function to call it from the
`slices_cp_parser`()	Parser for options for the slices_cp() function to call it from
`slices_cp`([input_file, output_directory, name, ...])	Function to compute slices using Paraview.

Module Contents

postprocessing.paraview.slices.slices_cp_cmd(): Wrapper around the slices_cp() function to call it from the command line with arguments.

postprocessing.paraview.slices.slices_cp_parser()

Parser for options for the slices_cp() function to call it from the command line with arguments.

Returns:

parser: Parser with specified arguments.

postprocessing.paraview.slices.slices_cp(input_file=None, output_directory='./', name='slice', patches='group/wall', span_direction='Z+', lift_direction='Y+', drag_direction='X+', x=None, rho0=None, u0=None, p0=None)

Function to compute slices using Paraview.

Parameters:

input_filestr: Path to file to load with Paraview.
output_directorystr: Path to directory where the slice files will be written. Default is “./”.
namestr: Name pattern to write out files in the output directory. Default is “slice”.
patchesstr or list: Patch name(s) over which to compute the slice(s). Default is “group/wall”.
span_directionstr or list: Vector direction for span direction either as a string (eg. X) or list (eg. [0 0 1]). Should be of magnitude 1. Default is “Z+”.
lift_directionstr or list: Vector direction for lift direction either as a string (eg. X+) or list (eg. [0 1 0]). Should be of magnitude 1. Default is “Y+”.
drag_directionstr or list: Vector direction for drag direction either as a string (eg. X+) or list (eg. [1 0 0]). Should be of magnitude 1. Default is “X+”.
xlist: Coordinates to sample.
rho0float: Freestream density.
u0float: Freestream velocity magnitude.
p0float: Freestream pressure.