g3d.flow.senv package

Submodules

g3d.flow.senv.g3dflow module

G3DFlow solver definitions (G3DFlow, G2DFlow, G2DAxiFlow, Q1DFlow, Q3DFlow)

class g3d.flow.senv.g3dflow.G2DAxiFlow(*args: Any, **kwargs: Any)[source]

Bases: G2DFlow

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.g3dflow.G2DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.g3dflow.G3DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.g3dflow.Q1DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.g3dflow.Q3DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test

g3d.flow.senv.solver_env module

solver environment (SolverEnv class definition)

class g3d.flow.senv.solver_env.SolverEnv(*args: Any, **kwargs: Any)[source]

Bases: G3DCode

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
add_BCMod(*args: Any, **kwargs: Any) → BCMod[source]
Parameters:

  • args

  • kwargs

Returns:

static add_TVD_limiter(m: Any) → None[source]
Parameters:

m

static add_to_nstep(N: int) → None[source]
Parameters:

N

auxvr() → None[source]
Returns:

bc_update_conservative(boco: BoCo) → None[source]
Parameters:

boco

bc_update_primitive(boco: BoCo) → None[source]
Parameters:

boco

bc_update_speed_of_sound(boco: BoCo) → None[source]
Parameters:

boco

property calculator: EmbeddedCFlow

return:

cell_get_block(kc: int) → int[source]
Parameters:

kc

Returns:

cell_get_ijk(kc: int) → Tuple[int, int, int][source]
Parameters:

kc

Returns:

check_FMP_metrics() → None[source]
check_cell_metrics(ic: int) → None[source]
Parameters:

ic

diff_flux_check() → None[source]
property dom: Domain

return:

export_cell_volume() → None[source]
export_field(field: FlowDataPlaceHolder, **kwargs: Any) → None[source]
Parameters:

  • field

  • kwargs

export_flow(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

export_inverse_cell_volume() → None[source]
export_mesh(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

Returns:

export_scalar(var, **kwargs: Any) → None[source]
Parameters:

  • var

  • kwargs

export_scalars(variables, **kwargs: Any) → None[source]
Parameters:

  • variables

  • kwargs

export_velocity_gradients(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

flux_check() → None[source]
generate_mesh_from_pipe_data(q1d: Q1DPipe) → None[source]
Parameters:

q1d

get_auxv_array(var: str = 'p') → ndarray[source]
Parameters:

var

Returns:

get_auxv_arrays() → Tuple[ndarray, ...][source]
Returns:

get_block_sizes(im: int) → Tuple[int, int, int][source]
Parameters:

im

Returns:

get_cell(im: int, i: int, j: int, k: int) → int[source]
Parameters:

  • im

  • i

  • j

  • k

Returns:

get_cell_centers() → Tuple[ndarray, ...][source]
Returns:

get_cons_array(var: str = 'ro') → ndarray[source]
Parameters:

var

Returns:

get_cons_arrays() → Tuple[ndarray, ...][source]
Returns:

get_gas() → Gas[source]
Returns:

get_gas_properties() → Tuple[float, float][source]
Returns:

static get_n_cells() → int[source]
Returns:

static get_n_faces() → int[source]
Returns:

static get_n_ghost_cells() → int[source]
Returns:

static get_n_ghost_nodes() → int[source]
Returns:

static get_n_nodes() → int[source]
Returns:

static get_new_Auxv() → Auxv[source]
Returns:

static get_new_BoCo(*args: Any, **kwargs: Any) → BoCo[source]
Parameters:

  • args

  • kwargs

Returns:

static get_new_Cons() → Cons[source]
Returns:

static get_new_Q1DPipe() → Q1DPipe[source]
Returns:

static get_new_Region() → IJKRegion[source]
Returns:

static get_new_matrix() → MatrixRows[source]
Returns:

get_node(im: int, i: int, j: int, k: int) → int[source]
Parameters:

  • im

  • i

  • j

  • k

Returns:

get_node_coordinates() → Tuple[ndarray, ...][source]
Returns:

get_post_array(var: str = 'M') → ndarray[source]
Parameters:

var

Returns:

get_post_arrays() → Tuple[ndarray, ...][source]
Returns:

static get_residual() → float[source]
Returns:

get_shock_capturing_field() → ndarray[source]
Returns:

get_streamtube_normal(idx: int | None = None) → float | ndarray[source]
Parameters:

idx

Returns:

static get_time() → float[source]
Returns:

get_volume(idx: int | None = None) → float | ndarray[source]
Parameters:

idx

Returns:

import_boundary_definitions(**kwargs: Any) → None[source]
Parameters:

kwargs

Returns:

import_flow_data(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

import_g3d_flow_data(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

import_mesh(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

initialize_block_flow_field(im: int, f: Auxv | Cons) → None[source]
Parameters:

  • im

  • f

initialize_flow_field(f: Auxv | Cons) → None[source]
Parameters:

f

initialize_from_conservative(ro: float, ru: float, rv: float, rw: float, et: float) → None[source]
Parameters:

  • ro

  • ru

  • rv

  • rw

  • et

initialize_from_primitive(p: float, u: float, v: float, w: float, t: float) → None[source]
Parameters:

  • p

  • u

  • v

  • w

  • t

initialize_linear(ql: Cons, qr: Cons, direction: str = 'x') → None[source]
Parameters:

  • ql

  • qr

  • direction

initialize_region_flow_field(r: IJKRegion, f: Auxv | Cons) → None[source]
Parameters:

  • r

  • f

jobname_append(name: str) → None[source]

extends jobname with the specified string input: name example: jobname_append(name)

ltsp_test() → None[source]
node_get_block(kp: int) → int[source]
Parameters:

kp

Returns:

node_get_ijk(kp: int) → Tuple[int, int, int][source]
Parameters:

kp

Returns:

plot_field_2D(field: FlowDataPlaceHolder, im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • field

  • im

  • k

  • kwargs

plot_flow_2D(im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • im

  • k

  • kwargs

plot_probe_array(var: ndarray, im: int, i0: int, j0: int, k0: int, idir: int, nci: int, **kwargs: Any) → None[source]
Parameters:

  • var

  • im

  • i0

  • j0

  • k0

  • idir

  • nci

  • kwargs

plot_scalar_2D(var: ndarray, im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • var

  • im

  • k

  • kwargs

plot_scalars_2D(variables: ndarray, im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • variables

  • im

  • k

  • kwargs

static remove_TVD_limiter(m: Any) → None[source]
Parameters:

m

run() → None[source]
static set_convection_scheme_coefs(c1: float, c2: float, c3: float, c4: float) → None[source]
Parameters:

  • c1

  • c2

  • c3

  • c4

static set_damp(fp: float, fc: float) → None[source]
Parameters:

  • fp

  • fc

set_from_key_value(key: str, value: Any) → bool[source]

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘verbose’, ‘silent/quiet’, ‘jobname’, ‘working_directory’, ‘dimension’, ‘cuda’, ‘prof’ example: set_from_key_value(key, value)

set_gas_properties(g, R) → None[source]
Parameters:

  • g

  • R

property solver: Solver

return:

step_test() → None[source]
update_BC(boco: BoCo) → None[source]
Parameters:

boco

update_BC_family(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

update_BC_type(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

Module contents

g3d/flow/senv sub library

class g3d.flow.senv.G2DAxiFlow(*args: Any, **kwargs: Any)[source]

Bases: G2DFlow

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.G2DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.G3DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.Q1DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.Q3DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.senv.SolverEnv(*args: Any, **kwargs: Any)[source]

Bases: G3DCode

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
add_BCMod(*args: Any, **kwargs: Any) → BCMod[source]
Parameters:

  • args

  • kwargs

Returns:

static add_TVD_limiter(m: Any) → None[source]
Parameters:

m

static add_to_nstep(N: int) → None[source]
Parameters:

N

auxvr() → None[source]
Returns:

bc_update_conservative(boco: BoCo) → None[source]
Parameters:

boco

bc_update_primitive(boco: BoCo) → None[source]
Parameters:

boco

bc_update_speed_of_sound(boco: BoCo) → None[source]
Parameters:

boco

property calculator: EmbeddedCFlow

return:

cell_get_block(kc: int) → int[source]
Parameters:

kc

Returns:

cell_get_ijk(kc: int) → Tuple[int, int, int][source]
Parameters:

kc

Returns:

check_FMP_metrics() → None[source]
check_cell_metrics(ic: int) → None[source]
Parameters:

ic

diff_flux_check() → None[source]
property dom: Domain

return:

export_cell_volume() → None[source]
export_field(field: FlowDataPlaceHolder, **kwargs: Any) → None[source]
Parameters:

  • field

  • kwargs

export_flow(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

export_inverse_cell_volume() → None[source]
export_mesh(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

Returns:

export_scalar(var, **kwargs: Any) → None[source]
Parameters:

  • var

  • kwargs

export_scalars(variables, **kwargs: Any) → None[source]
Parameters:

  • variables

  • kwargs

export_velocity_gradients(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

flux_check() → None[source]
generate_mesh_from_pipe_data(q1d: Q1DPipe) → None[source]
Parameters:

q1d

get_auxv_array(var: str = 'p') → ndarray[source]
Parameters:

var

Returns:

get_auxv_arrays() → Tuple[ndarray, ...][source]
Returns:

get_block_sizes(im: int) → Tuple[int, int, int][source]
Parameters:

im

Returns:

get_cell(im: int, i: int, j: int, k: int) → int[source]
Parameters:

  • im

  • i

  • j

  • k

Returns:

get_cell_centers() → Tuple[ndarray, ...][source]
Returns:

get_cons_array(var: str = 'ro') → ndarray[source]
Parameters:

var

Returns:

get_cons_arrays() → Tuple[ndarray, ...][source]
Returns:

get_gas() → Gas[source]
Returns:

get_gas_properties() → Tuple[float, float][source]
Returns:

static get_n_cells() → int[source]
Returns:

static get_n_faces() → int[source]
Returns:

static get_n_ghost_cells() → int[source]
Returns:

static get_n_ghost_nodes() → int[source]
Returns:

static get_n_nodes() → int[source]
Returns:

static get_new_Auxv() → Auxv[source]
Returns:

static get_new_BoCo(*args: Any, **kwargs: Any) → BoCo[source]
Parameters:

  • args

  • kwargs

Returns:

static get_new_Cons() → Cons[source]
Returns:

static get_new_Q1DPipe() → Q1DPipe[source]
Returns:

static get_new_Region() → IJKRegion[source]
Returns:

static get_new_matrix() → MatrixRows[source]
Returns:

get_node(im: int, i: int, j: int, k: int) → int[source]
Parameters:

  • im

  • i

  • j

  • k

Returns:

get_node_coordinates() → Tuple[ndarray, ...][source]
Returns:

get_post_array(var: str = 'M') → ndarray[source]
Parameters:

var

Returns:

get_post_arrays() → Tuple[ndarray, ...][source]
Returns:

static get_residual() → float[source]
Returns:

get_shock_capturing_field() → ndarray[source]
Returns:

get_streamtube_normal(idx: int | None = None) → float | ndarray[source]
Parameters:

idx

Returns:

static get_time() → float[source]
Returns:

get_volume(idx: int | None = None) → float | ndarray[source]
Parameters:

idx

Returns:

import_boundary_definitions(**kwargs: Any) → None[source]
Parameters:

kwargs

Returns:

import_flow_data(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

import_g3d_flow_data(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

import_mesh(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

initialize_block_flow_field(im: int, f: Auxv | Cons) → None[source]
Parameters:

  • im

  • f

initialize_flow_field(f: Auxv | Cons) → None[source]
Parameters:

f

initialize_from_conservative(ro: float, ru: float, rv: float, rw: float, et: float) → None[source]
Parameters:

  • ro

  • ru

  • rv

  • rw

  • et

initialize_from_primitive(p: float, u: float, v: float, w: float, t: float) → None[source]
Parameters:

  • p

  • u

  • v

  • w

  • t

initialize_linear(ql: Cons, qr: Cons, direction: str = 'x') → None[source]
Parameters:

  • ql

  • qr

  • direction

initialize_region_flow_field(r: IJKRegion, f: Auxv | Cons) → None[source]
Parameters:

  • r

  • f

jobname_append(name: str) → None[source]

extends jobname with the specified string input: name example: jobname_append(name)

ltsp_test() → None[source]
node_get_block(kp: int) → int[source]
Parameters:

kp

Returns:

node_get_ijk(kp: int) → Tuple[int, int, int][source]
Parameters:

kp

Returns:

plot_field_2D(field: FlowDataPlaceHolder, im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • field

  • im

  • k

  • kwargs

plot_flow_2D(im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • im

  • k

  • kwargs

plot_probe_array(var: ndarray, im: int, i0: int, j0: int, k0: int, idir: int, nci: int, **kwargs: Any) → None[source]
Parameters:

  • var

  • im

  • i0

  • j0

  • k0

  • idir

  • nci

  • kwargs

plot_scalar_2D(var: ndarray, im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • var

  • im

  • k

  • kwargs

plot_scalars_2D(variables: ndarray, im: int = 0, k: int = 0, **kwargs: Any) → None[source]
Parameters:

  • variables

  • im

  • k

  • kwargs

static remove_TVD_limiter(m: Any) → None[source]
Parameters:

m

run() → None[source]
static set_convection_scheme_coefs(c1: float, c2: float, c3: float, c4: float) → None[source]
Parameters:

  • c1

  • c2

  • c3

  • c4

static set_damp(fp: float, fc: float) → None[source]
Parameters:

  • fp

  • fc

set_from_key_value(key: str, value: Any) → bool[source]

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘verbose’, ‘silent/quiet’, ‘jobname’, ‘working_directory’, ‘dimension’, ‘cuda’, ‘prof’ example: set_from_key_value(key, value)

set_gas_properties(g, R) → None[source]
Parameters:

  • g

  • R

property solver: Solver

return:

step_test() → None[source]
update_BC(boco: BoCo) → None[source]
Parameters:

boco

update_BC_family(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs

update_BC_type(*args: Any, **kwargs: Any) → None[source]
Parameters:

  • args

  • kwargs