g3d.defs.world package

Subpackages

g3d.defs.world.numerics package

Submodules

g3d.defs.world.display module

G3DDisplay static class

class g3d.defs.world.display.G3DDisplay[source]

Bases: object

G3D display placeholder

Attributes:

plot_edges: plot_edges = True => mesh block edges will be printed on
print_iterations: print_iterations = True => residuals will be printed every
print_splash: print_splash = True => code splash (logo) will be printed
progress_bar: progress_bar = True => progress bar will be printed to std out
scrw: screen width (default value = 80)
silent: silent = True => limited solver output (default value = False)
verbose: verbose = True => more printed output (default value = False)

Methods

`author`()	prints author/developer information to std out input: no input example: author()
`header`(args, *kwargs)	prints header to std out input: args, kwargs args: info (header text (string)), dashes (default = '='), scrw (default = 80 or earlier specified scrw value) kwargs: 'info', 'dashes', 'scrw' example: header(args, kwargs)
`hline`(args, *kwargs)	prints horizontal line on screen input: args, kwargs args: dash (default = '-'), scrw (default = 80 or earlier specified scrw value) kwargs: 'dashes', 'scrw' example: hline(args, kwargs)
`logo`()	prints logo to std out logos defined for CFLOW, G3DMESH & G3DFLOW input: no input example: logo()
`splash`()	prints code splash to std out logo (code specific), code version & author information input: no input example: splash()

static author()[source]: prints author/developer information to std out input: no input example: author()

header(*args: Any, **kwargs: Any) → None[source]: prints header to std out input: args, kwargs args: info (header text (string)), dashes (default = ‘=’), scrw (default = 80 or earlier specified scrw value) kwargs: ‘info’, ‘dashes’, ‘scrw’ example: header(args, kwargs)

hline(*args: Any, **kwargs: Any) → None[source]: prints horizontal line on screen input: args, kwargs args: dash (default = ‘-‘), scrw (default = 80 or earlier specified scrw value) kwargs: ‘dashes’, ‘scrw’ example: hline(args, kwargs)

static logo() → None[source]: prints logo to std out logos defined for CFLOW, G3DMESH & G3DFLOW input: no input example: logo()

property plot_edges: bool: plot_edges = True => mesh block edges will be printed on mesh plot (default value = False)

property print_iterations: bool: print_iterations = True => residuals will be printed every iteration (default value = False)

property print_splash: bool: print_splash = True => code splash (logo) will be printed on solver start (default value = True)

property progress_bar: bool: progress_bar = True => progress bar will be printed to std out (default value = False)

property scrw: int: screen width (default value = 80)

property silent: bool: silent = True => limited solver output (default value = False)

splash() → None[source]: prints code splash to std out logo (code specific), code version & author information input: no input example: splash()

property verbose: bool: verbose = True => more printed output (default value = False)

g3d.defs.world.info module

G3DInfo static class

class g3d.defs.world.info.G3DInfo[source]

Bases: object

G3D code information placeholder

Attributes:

author: code author information
code_description: short code description
code_name: code name
code_sub_description: additional code description
code_type: code type (default value = CodeType.G3D_SOLVER)
date: date of latest code release
info_str: code information string
version: code version

property author: list[str]: code author information

property code_description: str: short code description

property code_name: str: code name

property code_sub_description: str: additional code description

property code_type: Any: code type (default value = CodeType.G3D_SOLVER)

property date: str: date of latest code release

property info_str: str: code information string code name, code version, date of latest release

property version: str: code version

g3d.defs.world.io module

G3DIOSettings static class

class g3d.defs.world.io.G3DIOSettings[source]

Bases: object

G3D I/O placeholder

Attributes:

jobname: jobname (default value = g3dflow)
msh: mesh file name (default value = ‘g3d.msh’)
prev_solution_folder: name of folder where the previous solver state (solution files) was stored
save_all_files: save_all_files = True => old files will not be replaced by new files
sol_dir: solution files directory (default value = ‘’)
topo: topology file name (default value = ‘g3d.topo’)
wd: working directory (default value = ./WD)
working_directory: same as wd

property jobname: str

property msh: str: mesh file name (default value = ‘g3d.msh’)

property prev_solution_folder: str: name of folder where the previous solver state (solution files) was stored

property save_all_files: bool: save_all_files = True => old files will not be replaced by new files (default value = False)

property sol_dir: str: solution files directory (default value = ‘’)

property topo: str: topology file name (default value = ‘g3d.topo’)

property wd: str: working directory (default value = ./WD)

property working_directory: str: same as wd

g3d.defs.world.models module

G3DModels static class

class g3d.defs.world.models.G3DModels[source]

Bases: object

G3D model settings placeholder

Attributes:

turbulence_model: turbulence model type (Enum, default value = TurbulenceModelMode.NO_TURBULENCE_MODEL)

property turbulence_model: Any: turbulence model type (Enum, default value = TurbulenceModelMode.NO_TURBULENCE_MODEL)

g3d.defs.world.options module

G3DRunOptions static class

class g3d.defs.world.options.G3DRunOptions[source]

Bases: object

G3D run options placeholder

Attributes:

attach_profiler: attach_profiler = True => profiler will be deployed on execution
auto_plot_residuals: auto_plot_residuals = True => residual plots will be generated
break_residual: target residual value for which the solver execution will be stopped
dim_mode: solver dimension mode (Enum, default value = DIMMode.G3D)
eqn_mode: solver equation mode (Enum, default value = EQNMode.DNS)
long_opt: long option string (descriptive options)
nstep: number of solver iterations
nstep_save: number of solver iterations between each save of solver state (flow field)
q3d_source_factor: source term factor used for the quasi-three-dimensional (Q3D) solver
restart: restart = True => solver will start from previously stored flow state if applicable
short_opt: short option string (one letter options)
use_irsm: use_irsm = True => implicit residual smoothing will be applied
use_residual_break: use_residual_break = True => solver execution will be stopped if reaching the target residual
use_velocity_gradients: use_velocity_gradients = True => velocity gradients will be calculated as part of flux evaluation

property attach_profiler: bool: attach_profiler = True => profiler will be deployed on execution (default value = False)

property auto_plot_residuals: bool: auto_plot_residuals = True => residual plots will be generated automatically (default value = False)

property break_residual: float: target residual value for which the solver execution will be stopped (default value = 1.e-7)

property dim_mode: Any: solver dimension mode (Enum, default value = DIMMode.G3D) valid options: Q1D, G2D, G2D_AXISYMM, G3D, Q3D

property eqn_mode: Any: solver equation mode (Enum, default value = EQNMode.DNS) valid options: EULER, NAVIER_STOKES, DNS, RANS, URANS, LES, DES, DDES

property long_opt: list[str]: long option string (descriptive options)

property nstep: int: number of solver iterations

property nstep_save: int: number of solver iterations between each save of solver state (flow field)

property q3d_source_factor: float: source term factor used for the quasi-three-dimensional (Q3D) solver (default value = 0.95)

property restart: bool: restart = True => solver will start from previously stored flow state if applicable (default value = True)

property short_opt: str: short option string (one letter options)

property use_irsm: bool: use_irsm = True => implicit residual smoothing will be applied (default value = False, can be triggered by, for example, setting a CFL number greater than 1.0)

property use_residual_break: bool: use_residual_break = True => solver execution will be stopped if reaching the target residual (default value = False)

property use_velocity_gradients: bool: use_velocity_gradients = True => velocity gradients will be calculated as part of flux evaluation (default value = False - depending on solver settings)

g3d.defs.world.sizes module

G3DSizes static class

class g3d.defs.world.sizes.G3DSizes[source]

Bases: object

G3D sizes placeholder

Attributes:

n_block_faces: total number of block cell faces
n_boundary_faces: total number of boundary cell faces
n_cells: total number of cells
n_connectivity_faces: total number of block connectivity cell faces
n_faces: total number of cell faces
n_ghost_cells: total number of ghost cells
n_ghost_nodes: total number of ghost nodes
n_internal_faces: total number of internal cell faces
n_internal_faces_i: total number of internal i-direction cell faces
n_internal_faces_j: total number of internal j-direction cell faces
n_internal_faces_k: total number of internal k-direction cell faces
n_nodes: total number of nodes
n_var: total number of solver variables

Methods

`add_block_faces`(n)	adds faces to total block face count input: n (number of faces to be added) example: add_block_faces(n)
`add_boundary_faces`(n)	adds faces to total boundary face count input: n (number of faces to be added) example: add_boundary_faces(n)
`add_cells`(n)	adds cells to total cell count input: n (number of cells to be added) example: add_cells(n)
`add_connectivity_faces`(n)	adds faces to total connectivity face count input: n (number of faces to be added) example: add_connectivity_faces(n)
`add_faces`(n)	adds faces to total face count input: n (number of faces to be added) example: add_faces(n)
`add_ghost_cells`(n)	adds cells to total ghost cell count input: n (number of cells to be added) example: add_ghost_cells(n)
`add_ghost_nodes`(n)	adds nodes to total ghost node count input: n (number of nodes to be added) example: add_ghost_nodes(n)
`add_internal_faces`(n)	adds faces to total internal face count input: n (number of faces to be added) example: add_internal_faces(n)
`add_internal_faces_i`(n)	adds faces to total i-direction internal face count input: n (number of faces to be added) example: add_internal_faces_i(n)
`add_internal_faces_j`(n)	adds faces to total j-direction internal face count input: n (number of faces to be added) example: add_internal_faces_j(n)
`add_internal_faces_k`(n)	adds faces to total k-direction internal face count input: n (number of faces to be added) example: add_internal_faces_k(n)
`add_nodes`(n)	adds nodes to total node count input: n (number of nodes to be added) example: add_nodes(n)
`subtract_block_faces`(n)	subtracts faces to total block face count input: n (number of faces to be subtracted) example: add_block_faces(n)
`subtract_boundary_faces`(n)	subtracts faces to total boundary face count input: n (number of faces to be subtracted) example: add_boundary_faces(n)
`subtract_cells`(n)	subtracts cells to total cell count input: n (number of cells to be subtracted) example: add_cells(n)
`subtract_connectivity_faces`(n)	subtracts faces to total connectivity face count input: n (number of faces to be subtracted) example: add_connectivity_faces(n)
`subtract_faces`(n)	subtracts faces to total face count input: n (number of faces to be subtracted) example: add_faces(n)
`subtract_ghost_cells`(n)	subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)
`subtract_ghost_nodes`(n)	subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)
`subtract_internal_faces`(n)	subtracts faces to total internal face count input: n (number of faces to be subtracted) example: add_internal_faces(n)
`subtract_internal_faces_i`(n)	subtracts faces to total i-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_i(n)
`subtract_internal_faces_j`(n)	subtracts faces to total j-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_j(n)
`subtract_internal_faces_k`(n)	subtracts faces to total k-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_k(n)
`subtract_nodes`(n)	subtract nodes to total node count input: n (number of nodes to be subtracted) example: subtract_nodes(n)

add_block_faces(n: int) → None[source]: adds faces to total block face count input: n (number of faces to be added) example: add_block_faces(n)

add_boundary_faces(n: int) → None[source]: adds faces to total boundary face count input: n (number of faces to be added) example: add_boundary_faces(n)

add_cells(n: int) → None[source]: adds cells to total cell count input: n (number of cells to be added) example: add_cells(n)

add_connectivity_faces(n: int) → None[source]: adds faces to total connectivity face count input: n (number of faces to be added) example: add_connectivity_faces(n)

add_faces(n: int) → None[source]: adds faces to total face count input: n (number of faces to be added) example: add_faces(n)

add_ghost_cells(n: int) → None[source]: adds cells to total ghost cell count input: n (number of cells to be added) example: add_ghost_cells(n)

add_ghost_nodes(n: int) → None[source]: adds nodes to total ghost node count input: n (number of nodes to be added) example: add_ghost_nodes(n)

add_internal_faces(n: int) → None[source]: adds faces to total internal face count input: n (number of faces to be added) example: add_internal_faces(n)

add_internal_faces_i(n: int) → None[source]: adds faces to total i-direction internal face count input: n (number of faces to be added) example: add_internal_faces_i(n)

add_internal_faces_j(n: int) → None[source]: adds faces to total j-direction internal face count input: n (number of faces to be added) example: add_internal_faces_j(n)

add_internal_faces_k(n: int) → None[source]: adds faces to total k-direction internal face count input: n (number of faces to be added) example: add_internal_faces_k(n)

add_nodes(n: int) → None[source]: adds nodes to total node count input: n (number of nodes to be added) example: add_nodes(n)

property n_block_faces: int: total number of block cell faces

property n_boundary_faces: int: total number of boundary cell faces

property n_cells: int: total number of cells

property n_connectivity_faces: int: total number of block connectivity cell faces

property n_faces: int: total number of cell faces

property n_ghost_cells: int: total number of ghost cells

property n_ghost_nodes: int: total number of ghost nodes

property n_internal_faces: int: total number of internal cell faces

property n_internal_faces_i: int: total number of internal i-direction cell faces

property n_internal_faces_j: int: total number of internal j-direction cell faces

property n_internal_faces_k: int: total number of internal k-direction cell faces

property n_nodes: int: total number of nodes

property n_var: int: total number of solver variables

subtract_block_faces(n: int) → None[source]: subtracts faces to total block face count input: n (number of faces to be subtracted) example: add_block_faces(n)

subtract_boundary_faces(n: int) → None[source]: subtracts faces to total boundary face count input: n (number of faces to be subtracted) example: add_boundary_faces(n)

subtract_cells(n: int) → None[source]: subtracts cells to total cell count input: n (number of cells to be subtracted) example: add_cells(n)

subtract_connectivity_faces(n: int) → None[source]: subtracts faces to total connectivity face count input: n (number of faces to be subtracted) example: add_connectivity_faces(n)

subtract_faces(n: int) → None[source]: subtracts faces to total face count input: n (number of faces to be subtracted) example: add_faces(n)

subtract_ghost_cells(n: int) → None[source]: subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)

subtract_ghost_nodes(n: int) → None[source]: subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)

subtract_internal_faces(n: int) → None[source]: subtracts faces to total internal face count input: n (number of faces to be subtracted) example: add_internal_faces(n)

subtract_internal_faces_i(n: int) → None[source]: subtracts faces to total i-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_i(n)

subtract_internal_faces_j(n: int) → None[source]: subtracts faces to total j-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_j(n)

subtract_internal_faces_k(n: int) → None[source]: subtracts faces to total k-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_k(n)

subtract_nodes(n: int) → None[source]: subtract nodes to total node count input: n (number of nodes to be subtracted) example: subtract_nodes(n)

g3d.defs.world.status module

G3DSolverStatus static class

class g3d.defs.world.status.G3DSolverStatus[source]

Bases: object

G3D solver status placeholder

Attributes:

curiter: completed iterations at last solver state save
istep: number of iterations since start
istep_save: number of iterations since last solver state save
residual: solver residual
time: simulated time

property curiter: int: completed iterations at last solver state save

property istep: int: number of iterations since start

property istep_save: int: number of iterations since last solver state save

property residual: float: solver residual

property time: float: simulated time

g3d.defs.world.world module

G3DWorld static class

class g3d.defs.world.world.G3DWorld[source]

Bases: object

G3D World placeholder

Attributes:

display: instance of G3D display placeholder
info: instance of G3D info placeholder
io: instance of G3D I/O placeholder
models: instance of G3D models placeholder
num: instance of G3D numerics placeholder
options: instance of G3D options placeholder
sizes: instance of G3D sizes placeholder
status: instance of G3D status placeholder

property display: G3DDisplay: instance of G3D display placeholder

property info: G3DInfo: instance of G3D info placeholder

property io: G3DIOSettings: instance of G3D I/O placeholder

property models: G3DModels: instance of G3D models placeholder

property num: G3DNum: instance of G3D numerics placeholder

property options: G3DRunOptions: instance of G3D options placeholder

property sizes: G3DSizes: instance of G3D sizes placeholder

property status: G3DSolverStatus: instance of G3D status placeholder

Module contents

g3d/defs/world sub library

class g3d.defs.world.G3DDisplay[source]

Bases: object

G3D display placeholder

Attributes:

plot_edges: plot_edges = True => mesh block edges will be printed on
print_iterations: print_iterations = True => residuals will be printed every
print_splash: print_splash = True => code splash (logo) will be printed
progress_bar: progress_bar = True => progress bar will be printed to std out
scrw: screen width (default value = 80)
silent: silent = True => limited solver output (default value = False)
verbose: verbose = True => more printed output (default value = False)

Methods

`author`()	prints author/developer information to std out input: no input example: author()
`header`(args, *kwargs)	prints header to std out input: args, kwargs args: info (header text (string)), dashes (default = '='), scrw (default = 80 or earlier specified scrw value) kwargs: 'info', 'dashes', 'scrw' example: header(args, kwargs)
`hline`(args, *kwargs)	prints horizontal line on screen input: args, kwargs args: dash (default = '-'), scrw (default = 80 or earlier specified scrw value) kwargs: 'dashes', 'scrw' example: hline(args, kwargs)
`logo`()	prints logo to std out logos defined for CFLOW, G3DMESH & G3DFLOW input: no input example: logo()
`splash`()	prints code splash to std out logo (code specific), code version & author information input: no input example: splash()

static author()[source]: prints author/developer information to std out input: no input example: author()

header(*args: Any, **kwargs: Any) → None[source]: prints header to std out input: args, kwargs args: info (header text (string)), dashes (default = ‘=’), scrw (default = 80 or earlier specified scrw value) kwargs: ‘info’, ‘dashes’, ‘scrw’ example: header(args, kwargs)

hline(*args: Any, **kwargs: Any) → None[source]: prints horizontal line on screen input: args, kwargs args: dash (default = ‘-‘), scrw (default = 80 or earlier specified scrw value) kwargs: ‘dashes’, ‘scrw’ example: hline(args, kwargs)

static logo() → None[source]: prints logo to std out logos defined for CFLOW, G3DMESH & G3DFLOW input: no input example: logo()

property plot_edges: bool: plot_edges = True => mesh block edges will be printed on mesh plot (default value = False)

property print_iterations: bool: print_iterations = True => residuals will be printed every iteration (default value = False)

property print_splash: bool: print_splash = True => code splash (logo) will be printed on solver start (default value = True)

property progress_bar: bool: progress_bar = True => progress bar will be printed to std out (default value = False)

property scrw: int: screen width (default value = 80)

property silent: bool: silent = True => limited solver output (default value = False)

splash() → None[source]: prints code splash to std out logo (code specific), code version & author information input: no input example: splash()

property verbose: bool: verbose = True => more printed output (default value = False)

class g3d.defs.world.G3DIOSettings[source]

Bases: object

G3D I/O placeholder

Attributes:

jobname: jobname (default value = g3dflow)
msh: mesh file name (default value = ‘g3d.msh’)
prev_solution_folder: name of folder where the previous solver state (solution files) was stored
save_all_files: save_all_files = True => old files will not be replaced by new files
sol_dir: solution files directory (default value = ‘’)
topo: topology file name (default value = ‘g3d.topo’)
wd: working directory (default value = ./WD)
working_directory: same as wd

property jobname: str

property msh: str: mesh file name (default value = ‘g3d.msh’)

property prev_solution_folder: str: name of folder where the previous solver state (solution files) was stored

property save_all_files: bool: save_all_files = True => old files will not be replaced by new files (default value = False)

property sol_dir: str: solution files directory (default value = ‘’)

property topo: str: topology file name (default value = ‘g3d.topo’)

property wd: str: working directory (default value = ./WD)

property working_directory: str: same as wd

class g3d.defs.world.G3DIRSM[source]

Bases: object

G3D Implicit Residual Smoothing (IRSM) placeholder

Attributes:

cfl_activate: IRSM activation CFL value (default 1.0)
cfl_crit: IRSM critical CFL value (default 1.2)
cfl_max: IRSM critical CFL max (default 0.0)
irsm_lambda: IRMS lambda value (default lambda = 1.0)
lambda_factor: IRSM lambda factor (default 0.25)
lambda_max: IRSM lambda max value (default 0.0)
lambda_min: IRSM lambda min value (default 1.0)
lambda_specified_by_user: IRSM lambda has been specified by user (default = False)
relax: IRSM under relaxation factor (default 0.9)

Methods

update_lambda()

update IRSM lambda value input: no input needed example: update_lambda()

property cfl_activate: float: IRSM activation CFL value (default 1.0)

property cfl_crit: float: IRSM critical CFL value (default 1.2)

property cfl_max: float: IRSM critical CFL max (default 0.0)

property irsm_lambda: float: IRMS lambda value (default lambda = 1.0)

property lambda_factor: float: IRSM lambda factor (default 0.25)

property lambda_max: float: IRSM lambda max value (default 0.0)

property lambda_min: float: IRSM lambda min value (default 1.0)

property lambda_specified_by_user: bool: IRSM lambda has been specified by user (default = False)

property relax: float: IRSM under relaxation factor (default 0.9)

update_lambda() → None[source]: update IRSM lambda value input: no input needed example: update_lambda()

class g3d.defs.world.G3DInfo[source]

Bases: object

G3D code information placeholder

Attributes:

author: code author information
code_description: short code description
code_name: code name
code_sub_description: additional code description
code_type: code type (default value = CodeType.G3D_SOLVER)
date: date of latest code release
info_str: code information string
version: code version

property author: list[str]: code author information

property code_description: str: short code description

property code_name: str: code name

property code_sub_description: str: additional code description

property code_type: Any: code type (default value = CodeType.G3D_SOLVER)

property date: str: date of latest code release

property info_str: str: code information string code name, code version, date of latest release

property version: str: code version

class g3d.defs.world.G3DLimiters[source]

Bases: object

G3D limiters placeholder

Attributes:

p_max: maximum pressure (default None)
p_min: minimum pressure (default None)
t_max: maximum temperature (default None)
t_min: minimum temperature (default None)

property p_max: float: maximum pressure (default None)

property p_min: float: minimum pressure (default None)

property t_max: float: maximum temperature (default None)

property t_min: float: minimum temperature (default None)

class g3d.defs.world.G3DNum[source]

Bases: object

G3D numerics placeholder

Attributes:

irsm: instance of G3D IRSM placeholder
limiters: instance of G3D limiters placeholder
scheme: instance of G3D numerical scheme placeholder
time: instance of G3D time placeholder

property irsm: G3DIRSM: instance of G3D IRSM placeholder

property limiters: G3DLimiters: instance of G3D limiters placeholder

property scheme: G3DScheme: instance of G3D numerical scheme placeholder

property time: G3DTime: instance of G3D time placeholder

class g3d.defs.world.G3DRunOptions[source]

Bases: object

G3D run options placeholder

Attributes:

attach_profiler: attach_profiler = True => profiler will be deployed on execution
auto_plot_residuals: auto_plot_residuals = True => residual plots will be generated
break_residual: target residual value for which the solver execution will be stopped
dim_mode: solver dimension mode (Enum, default value = DIMMode.G3D)
eqn_mode: solver equation mode (Enum, default value = EQNMode.DNS)
long_opt: long option string (descriptive options)
nstep: number of solver iterations
nstep_save: number of solver iterations between each save of solver state (flow field)
q3d_source_factor: source term factor used for the quasi-three-dimensional (Q3D) solver
restart: restart = True => solver will start from previously stored flow state if applicable
short_opt: short option string (one letter options)
use_irsm: use_irsm = True => implicit residual smoothing will be applied
use_residual_break: use_residual_break = True => solver execution will be stopped if reaching the target residual
use_velocity_gradients: use_velocity_gradients = True => velocity gradients will be calculated as part of flux evaluation

property attach_profiler: bool: attach_profiler = True => profiler will be deployed on execution (default value = False)

property auto_plot_residuals: bool: auto_plot_residuals = True => residual plots will be generated automatically (default value = False)

property break_residual: float: target residual value for which the solver execution will be stopped (default value = 1.e-7)

property dim_mode: Any: solver dimension mode (Enum, default value = DIMMode.G3D) valid options: Q1D, G2D, G2D_AXISYMM, G3D, Q3D

property eqn_mode: Any: solver equation mode (Enum, default value = EQNMode.DNS) valid options: EULER, NAVIER_STOKES, DNS, RANS, URANS, LES, DES, DDES

property long_opt: list[str]: long option string (descriptive options)

property nstep: int: number of solver iterations

property nstep_save: int: number of solver iterations between each save of solver state (flow field)

property q3d_source_factor: float: source term factor used for the quasi-three-dimensional (Q3D) solver (default value = 0.95)

property restart: bool: restart = True => solver will start from previously stored flow state if applicable (default value = True)

property short_opt: str: short option string (one letter options)

property use_irsm: bool: use_irsm = True => implicit residual smoothing will be applied (default value = False, can be triggered by, for example, setting a CFL number greater than 1.0)

property use_residual_break: bool: use_residual_break = True => solver execution will be stopped if reaching the target residual (default value = False)

property use_velocity_gradients: bool: use_velocity_gradients = True => velocity gradients will be calculated as part of flux evaluation (default value = False - depending on solver settings)

class g3d.defs.world.G3DScheme[source]

Bases: object

G3D numerical scheme placeholder

Attributes:

coef_1: convective scheme coefficient 1 (of four coefficients defining the scheme)
coef_2: convective scheme coefficient 2 (of four coefficients defining the scheme)
coef_3: convective scheme coefficient 3 (of four coefficients defining the scheme)
coef_4: convective scheme coefficient 4 (of four coefficients defining the scheme)
convective_scheme: convective scheme of G3DFlow cfd solver
entropy_damp_coef: entropy damping coefficient (default value = 0.0)
shock_damp_coef: shock damping coefficient (default value = 0.0)
shock_damping_mode: shock damping mode (Enum, default value = ShockDampingMode.JAMESON)
use_density_tvd_limiter: use density TVD limiter (default value = False)
use_turbulence_model_tvd_limiter: use turbulence model TVD limiter (default value = False)

Methods

`get_coefs`()	returns an array with coefficients of the convective scheme input: no input example: [c1, c2, c3, c4] = get_coefs()
`numerical_scheme_report`()	prints solver convective scheme input: no input
`set_coefs`(c1, c2, c3, c4)	defining convective scheme by specifying four coefficients input: coefficients (c1, c2, c3, c4)

property coef_1: float: convective scheme coefficient 1 (of four coefficients defining the scheme)

property coef_2: float: convective scheme coefficient 2 (of four coefficients defining the scheme)

property coef_3: float: convective scheme coefficient 3 (of four coefficients defining the scheme)

property coef_4: float: convective scheme coefficient 4 (of four coefficients defining the scheme)

property convective_scheme: Any: convective scheme of G3DFlow cfd solver

property entropy_damp_coef: float: entropy damping coefficient (default value = 0.0)

get_coefs() → ndarray[source]: returns an array with coefficients of the convective scheme input: no input example: [c1, c2, c3, c4] = get_coefs()

numerical_scheme_report() → None[source]: prints solver convective scheme input: no input

set_coefs(c1: float, c2: float, c3: float, c4: float) → None[source]: defining convective scheme by specifying four coefficients input: coefficients (c1, c2, c3, c4)

property shock_damp_coef: float: shock damping coefficient (default value = 0.0)

property shock_damping_mode: Any: shock damping mode (Enum, default value = ShockDampingMode.JAMESON) valid options: JAMESON, DUCROSS_FACE_GRADIENTS, DUCROSS_CELL_GRADIENTS

property use_density_tvd_limiter: bool: use density TVD limiter (default value = False)

property use_turbulence_model_tvd_limiter: bool: use turbulence model TVD limiter (default value = False)

class g3d.defs.world.G3DSizes[source]

Bases: object

G3D sizes placeholder

Attributes:

n_block_faces: total number of block cell faces
n_boundary_faces: total number of boundary cell faces
n_cells: total number of cells
n_connectivity_faces: total number of block connectivity cell faces
n_faces: total number of cell faces
n_ghost_cells: total number of ghost cells
n_ghost_nodes: total number of ghost nodes
n_internal_faces: total number of internal cell faces
n_internal_faces_i: total number of internal i-direction cell faces
n_internal_faces_j: total number of internal j-direction cell faces
n_internal_faces_k: total number of internal k-direction cell faces
n_nodes: total number of nodes
n_var: total number of solver variables

Methods

`add_block_faces`(n)	adds faces to total block face count input: n (number of faces to be added) example: add_block_faces(n)
`add_boundary_faces`(n)	adds faces to total boundary face count input: n (number of faces to be added) example: add_boundary_faces(n)
`add_cells`(n)	adds cells to total cell count input: n (number of cells to be added) example: add_cells(n)
`add_connectivity_faces`(n)	adds faces to total connectivity face count input: n (number of faces to be added) example: add_connectivity_faces(n)
`add_faces`(n)	adds faces to total face count input: n (number of faces to be added) example: add_faces(n)
`add_ghost_cells`(n)	adds cells to total ghost cell count input: n (number of cells to be added) example: add_ghost_cells(n)
`add_ghost_nodes`(n)	adds nodes to total ghost node count input: n (number of nodes to be added) example: add_ghost_nodes(n)
`add_internal_faces`(n)	adds faces to total internal face count input: n (number of faces to be added) example: add_internal_faces(n)
`add_internal_faces_i`(n)	adds faces to total i-direction internal face count input: n (number of faces to be added) example: add_internal_faces_i(n)
`add_internal_faces_j`(n)	adds faces to total j-direction internal face count input: n (number of faces to be added) example: add_internal_faces_j(n)
`add_internal_faces_k`(n)	adds faces to total k-direction internal face count input: n (number of faces to be added) example: add_internal_faces_k(n)
`add_nodes`(n)	adds nodes to total node count input: n (number of nodes to be added) example: add_nodes(n)
`subtract_block_faces`(n)	subtracts faces to total block face count input: n (number of faces to be subtracted) example: add_block_faces(n)
`subtract_boundary_faces`(n)	subtracts faces to total boundary face count input: n (number of faces to be subtracted) example: add_boundary_faces(n)
`subtract_cells`(n)	subtracts cells to total cell count input: n (number of cells to be subtracted) example: add_cells(n)
`subtract_connectivity_faces`(n)	subtracts faces to total connectivity face count input: n (number of faces to be subtracted) example: add_connectivity_faces(n)
`subtract_faces`(n)	subtracts faces to total face count input: n (number of faces to be subtracted) example: add_faces(n)
`subtract_ghost_cells`(n)	subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)
`subtract_ghost_nodes`(n)	subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)
`subtract_internal_faces`(n)	subtracts faces to total internal face count input: n (number of faces to be subtracted) example: add_internal_faces(n)
`subtract_internal_faces_i`(n)	subtracts faces to total i-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_i(n)
`subtract_internal_faces_j`(n)	subtracts faces to total j-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_j(n)
`subtract_internal_faces_k`(n)	subtracts faces to total k-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_k(n)
`subtract_nodes`(n)	subtract nodes to total node count input: n (number of nodes to be subtracted) example: subtract_nodes(n)

add_block_faces(n: int) → None[source]: adds faces to total block face count input: n (number of faces to be added) example: add_block_faces(n)

add_boundary_faces(n: int) → None[source]: adds faces to total boundary face count input: n (number of faces to be added) example: add_boundary_faces(n)

add_cells(n: int) → None[source]: adds cells to total cell count input: n (number of cells to be added) example: add_cells(n)

add_connectivity_faces(n: int) → None[source]: adds faces to total connectivity face count input: n (number of faces to be added) example: add_connectivity_faces(n)

add_faces(n: int) → None[source]: adds faces to total face count input: n (number of faces to be added) example: add_faces(n)

add_ghost_cells(n: int) → None[source]: adds cells to total ghost cell count input: n (number of cells to be added) example: add_ghost_cells(n)

add_ghost_nodes(n: int) → None[source]: adds nodes to total ghost node count input: n (number of nodes to be added) example: add_ghost_nodes(n)

add_internal_faces(n: int) → None[source]: adds faces to total internal face count input: n (number of faces to be added) example: add_internal_faces(n)

add_internal_faces_i(n: int) → None[source]: adds faces to total i-direction internal face count input: n (number of faces to be added) example: add_internal_faces_i(n)

add_internal_faces_j(n: int) → None[source]: adds faces to total j-direction internal face count input: n (number of faces to be added) example: add_internal_faces_j(n)

add_internal_faces_k(n: int) → None[source]: adds faces to total k-direction internal face count input: n (number of faces to be added) example: add_internal_faces_k(n)

add_nodes(n: int) → None[source]: adds nodes to total node count input: n (number of nodes to be added) example: add_nodes(n)

property n_block_faces: int: total number of block cell faces

property n_boundary_faces: int: total number of boundary cell faces

property n_cells: int: total number of cells

property n_connectivity_faces: int: total number of block connectivity cell faces

property n_faces: int: total number of cell faces

property n_ghost_cells: int: total number of ghost cells

property n_ghost_nodes: int: total number of ghost nodes

property n_internal_faces: int: total number of internal cell faces

property n_internal_faces_i: int: total number of internal i-direction cell faces

property n_internal_faces_j: int: total number of internal j-direction cell faces

property n_internal_faces_k: int: total number of internal k-direction cell faces

property n_nodes: int: total number of nodes

property n_var: int: total number of solver variables

subtract_block_faces(n: int) → None[source]: subtracts faces to total block face count input: n (number of faces to be subtracted) example: add_block_faces(n)

subtract_boundary_faces(n: int) → None[source]: subtracts faces to total boundary face count input: n (number of faces to be subtracted) example: add_boundary_faces(n)

subtract_cells(n: int) → None[source]: subtracts cells to total cell count input: n (number of cells to be subtracted) example: add_cells(n)

subtract_connectivity_faces(n: int) → None[source]: subtracts faces to total connectivity face count input: n (number of faces to be subtracted) example: add_connectivity_faces(n)

subtract_faces(n: int) → None[source]: subtracts faces to total face count input: n (number of faces to be subtracted) example: add_faces(n)

subtract_ghost_cells(n: int) → None[source]: subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)

subtract_ghost_nodes(n: int) → None[source]: subtracts cells to total ghost cell count input: n (number of cells to be subtracted) example: add_ghost_cells(n)

subtract_internal_faces(n: int) → None[source]: subtracts faces to total internal face count input: n (number of faces to be subtracted) example: add_internal_faces(n)

subtract_internal_faces_i(n: int) → None[source]: subtracts faces to total i-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_i(n)

subtract_internal_faces_j(n: int) → None[source]: subtracts faces to total j-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_j(n)

subtract_internal_faces_k(n: int) → None[source]: subtracts faces to total k-direction internal face count input: n (number of faces to be subtracted) example: add_internal_faces_k(n)

subtract_nodes(n: int) → None[source]: subtract nodes to total node count input: n (number of nodes to be subtracted) example: subtract_nodes(n)

class g3d.defs.world.G3DSolverStatus[source]

Bases: object

G3D solver status placeholder

Attributes:

curiter: completed iterations at last solver state save
istep: number of iterations since start
istep_save: number of iterations since last solver state save
residual: solver residual
time: simulated time

property curiter: int: completed iterations at last solver state save

property istep: int: number of iterations since start

property istep_save: int: number of iterations since last solver state save

property residual: float: solver residual

property time: float: simulated time

class g3d.defs.world.G3DTime[source]

Bases: object

G3D time placeholder

Attributes:

cfl: solver CFL number (default value = 0.9)
dtime: solver time step (used in combination with time-accurate time mode)
n_sub_iter: maximum number of subiterations (used in combination with dual time stepping time mode)
time_mode: solver time mode (Enum, default value = TIMESTEPTypes.LOCAL_TIME_STEPPING)
time_stepper_mode: solver time stepper mode (Enum, default value = TimeStepperMode.EXPLICIT_RUNGE_KUTTA)

property cfl: float: solver CFL number (default value = 0.9)

property dtime: float: solver time step (used in combination with time-accurate time mode)

property n_sub_iter: int: maximum number of subiterations (used in combination with dual time stepping time mode)

property time_mode: Any: solver time mode (Enum, default value = TIMESTEPTypes.LOCAL_TIME_STEPPING) valid options: LOCAL_TIME_STEPPING, TIME_ACCURATE_CFL, TIME_ACCURATE_CONSTANT_TIME_STEP

property time_stepper_mode: Any: solver time stepper mode (Enum, default value = TimeStepperMode.EXPLICIT_RUNGE_KUTTA) valid options: EXPLICIT_RUNGE_KUTTA, BACKWARD_EULER_DUAL_TIME_STEPPER, CRANK_NICOLSON_DUAL_TIME_STEPPER, TURKEL_BACKWARD_EULER_DUAL_TIME_STEPPER

class g3d.defs.world.G3DWorld[source]

Bases: object

G3D World placeholder

Attributes:

display: instance of G3D display placeholder
info: instance of G3D info placeholder
io: instance of G3D I/O placeholder
models: instance of G3D models placeholder
num: instance of G3D numerics placeholder
options: instance of G3D options placeholder
sizes: instance of G3D sizes placeholder
status: instance of G3D status placeholder

property display: G3DDisplay: instance of G3D display placeholder

property info: G3DInfo: instance of G3D info placeholder

property io: G3DIOSettings: instance of G3D I/O placeholder

property models: G3DModels: instance of G3D models placeholder

property num: G3DNum: instance of G3D numerics placeholder

property options: G3DRunOptions: instance of G3D options placeholder

property sizes: G3DSizes: instance of G3D sizes placeholder

property status: G3DSolverStatus: instance of G3D status placeholder