Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove junk comments and code + check in CI #777

Merged
merged 7 commits into from
Dec 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/formatting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on: [push, pull_request, workflow_dispatch]

jobs:
docs:
name: Code formatting
name: Formatting
runs-on: ubuntu-latest

steps:
Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/lint-source.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,10 @@ jobs:
run: |
! grep -iR 'double_precision\|dsqrt\|dexp\|dlog\|dble\|dabs\|double\ precision\|real(8)\|real(4)\|dprod\|dmin\|dmax\|dfloat\|dreal\|dcos\|dsin\|dtan\|dsign\|dtanh\|dsinh\|dcosh\|d0' --exclude-dir=syscheck --exclude="*nvtx*" --exclude="*precision_select*" ./src/*

- name: Looking for junk code
run: |
! grep -iR -e '\.\.\.' -e '\-\-\-' -e '===' ./src/*

- name: Looking for junk comments in examples
run: |
! grep -R '# ===' ./examples/**/*.py
256 changes: 117 additions & 139 deletions examples/0D_bubblecollapse_adap/case.py
Original file line number Diff line number Diff line change
@@ -1,163 +1,141 @@
#!/usr/bin/env python2

import math
import json

# FLUID PROPERTIES ============================================================
# Water
n_tait = 7.1
B_tait = 306.E+06
rho0 = 1.E+03
mul0 = 1.002E-03
ss = 0.07275
pv = 2.3388E+03
n_tait = 7.1
B_tait = 306.0e06
rho0 = 1.0e03
mul0 = 1.002e-03
ss = 0.07275
pv = 2.3388e03

# Vapor
gamma_v = 1.33
M_v = 18.02
mu_v = 0.8816E-05
k_v = 0.019426
M_v = 18.02
mu_v = 0.8816e-05
k_v = 0.019426

# Air
gamma_n = 1.4
M_n = 28.97
mu_n = 1.8E-05
k_n = 0.02556
M_n = 28.97
mu_n = 1.8e-05
k_n = 0.02556

# REFERENCE VALUES ============================================================
R0ref = 50.E-06
x0 = R0ref
p0 = 8236. # for Ca = 1 in mixing layer scale
u0 = math.sqrt( p0/rho0 )
patm = 1.
cact = math.sqrt(n_tait*(p0+B_tait)/rho0)
R0ref = 50.0e-06
x0 = R0ref
p0 = 8236.0 # for Ca = 1 in mixing layer scale
u0 = math.sqrt(p0 / rho0)
patm = 1.0
cact = math.sqrt(n_tait * (p0 + B_tait) / rho0)

# NONDIMENSIONAL NUMBERS ======================================================
Ca = (p0 - pv)/(rho0*(u0**2.)) # Cavitation number
We = rho0*(u0**2.)*R0ref/ss # Weber number
Re_inv = mul0/(rho0*u0*R0ref) # Inv. bubble Reynolds number
Ca = (p0 - pv) / (rho0 * (u0**2.0)) # Cavitation number
We = rho0 * (u0**2.0) * R0ref / ss # Weber number
Re_inv = mul0 / (rho0 * u0 * R0ref) # Inv. bubble Reynolds number

# BUBBLES =====================================================================
vf0 = 1e-5
nb = 1
vf0 = 1e-5
nb = 1

# DOMAIN ======================================================================
Nx = 30
Ldomain = 20.E-03
L = Ldomain/x0
dx = L/float(Nx+1)
Nx = 30
Ldomain = 20.0e-03
L = Ldomain / x0
dx = L / float(Nx + 1)

# TIME STEPS ==================================================================
Tfinal = 0.05
Nt = int(5e2+1)
t_save = 1
dt = Tfinal/(Nt-1)
Tfinal = 0.05
Nt = int(5e2 + 1)
t_save = 1
dt = Tfinal / (Nt - 1)

# Configuring case dictionary
print(json.dumps({
# Logistics ================================================
'run_time_info' : 'T',
# ==========================================================

# Computational Domain Parameters ==========================
'x_domain%beg' : -0.5*L,
'x_domain%end' : 0.5*L,
'stretch_x' : 'F',
'cyl_coord' : 'F',
'm' : Nx,
'n' : 0,
'p' : 0,
'dt' : dt,
't_step_start' : 0,
't_step_stop' : Nt,
't_step_save' : t_save,
# ==========================================================

# Simulation Algorithm Parameters ==========================
'num_patches' : 1,
'model_eqns' : 2,
'alt_soundspeed' : 'F',
'num_fluids' : 1,
'mpp_lim' : 'F',
'mixture_err' : 'F',
'time_stepper' : 3,
'weno_order' : 5,
'weno_eps' : 1.E-16,
'mapped_weno' : 'T',
'null_weights' : 'F',
'mp_weno' : 'T',
'riemann_solver' : 2,
'wave_speeds' : 1,
'avg_state' : 2,
'bc_x%beg' : -1,
'bc_x%end' : -1,
# ==========================================================

# Formatted Database Files Structure Parameters ============
'format' : 1,
'precision' : 2,
'prim_vars_wrt' :'T',
'parallel_io' :'T',
'fd_order' : 1,
# ==========================================================

# Patch 1 _ Background =====================================
'patch_icpp(1)%geometry' : 1,
'patch_icpp(1)%x_centroid' : 0.,
'patch_icpp(1)%length_x' : L,
'patch_icpp(1)%vel(1)' : 0.,
'patch_icpp(1)%pres' : 1000.,
'patch_icpp(1)%alpha_rho(1)' : (1.-vf0),
'patch_icpp(1)%alpha(1)' : vf0,
'patch_icpp(1)%r0' : 1.,
'patch_icpp(1)%v0' : 0.,
# ==========================================================

# Non-polytropic gas compression model AND/OR Tait EOS =====
'pref' : p0,
'rhoref' : rho0,
# ==========================================================

# Bubbles ==================================================
'bubbles_euler' : 'T',
'bubble_model' : 2,

# Nondimensional numbers
'Ca' : Ca,
'Web' : We,
'Re_inv' : Re_inv,

# adv_n
'adv_n' : 'T',

# adap_dt
'adap_dt' : 'T',

# Gas compression model
'polytropic' : 'T',
'thermal' : 1,

# Polydispersity
'polydisperse' : 'F',
'nb' : nb,

# QBMM
'qbmm' : 'F',
# ==========================================================

# Fluids Physical Parameters ===============================
# Surrounding liquid
'fluid_pp(1)%gamma' : 1.E+00/(n_tait-1.E+00),
'fluid_pp(1)%pi_inf' : n_tait*(B_tait/p0)/(n_tait-1.),
'fluid_pp(1)%ss' : ss,
'fluid_pp(1)%pv' : pv,

# Last fluid_pp is always reserved for bubble gas state ===
# if applicable ==========================================
'fluid_pp(2)%gamma' : 1./(gamma_n-1.),
'fluid_pp(2)%pi_inf' : 0.0E+00,
# ==========================================================

}))

# ==============================================================================
print(
json.dumps(
{
# Logistics ================================================
"run_time_info": "T",
# Computational Domain Parameters ==========================
"x_domain%beg": -0.5 * L,
"x_domain%end": 0.5 * L,
"stretch_x": "F",
"cyl_coord": "F",
"m": Nx,
"n": 0,
"p": 0,
"dt": dt,
"t_step_start": 0,
"t_step_stop": Nt,
"t_step_save": t_save,
# Simulation Algorithm Parameters ==========================
"num_patches": 1,
"model_eqns": 2,
"alt_soundspeed": "F",
"num_fluids": 1,
"mpp_lim": "F",
"mixture_err": "F",
"time_stepper": 3,
"weno_order": 5,
"weno_eps": 1.0e-16,
"mapped_weno": "T",
"null_weights": "F",
"mp_weno": "T",
"riemann_solver": 2,
"wave_speeds": 1,
"avg_state": 2,
"bc_x%beg": -1,
"bc_x%end": -1,
# Formatted Database Files Structure Parameters ============
"format": 1,
"precision": 2,
"prim_vars_wrt": "T",
"parallel_io": "T",
"fd_order": 1,
# Patch 1 _ Background =====================================
"patch_icpp(1)%geometry": 1,
"patch_icpp(1)%x_centroid": 0.0,
"patch_icpp(1)%length_x": L,
"patch_icpp(1)%vel(1)": 0.0,
"patch_icpp(1)%pres": 1000.0,
"patch_icpp(1)%alpha_rho(1)": (1.0 - vf0),
"patch_icpp(1)%alpha(1)": vf0,
"patch_icpp(1)%r0": 1.0,
"patch_icpp(1)%v0": 0.0,
# Non-polytropic gas compression model AND/OR Tait EOS =====
"pref": p0,
"rhoref": rho0,
# Bubbles ==================================================
"bubbles_euler": "T",
"bubble_model": 2,
# Nondimensional numbers
"Ca": Ca,
"Web": We,
"Re_inv": Re_inv,
# adv_n
"adv_n": "T",
# adap_dt
"adap_dt": "T",
# Gas compression model
"polytropic": "T",
"thermal": 1,
# Polydispersity
"polydisperse": "F",
"nb": nb,
# QBMM
"qbmm": "F",
# Fluids Physical Parameters ===============================
# Surrounding liquid
"fluid_pp(1)%gamma": 1.0e00 / (n_tait - 1.0e00),
"fluid_pp(1)%pi_inf": n_tait * (B_tait / p0) / (n_tait - 1.0),
"fluid_pp(1)%ss": ss,
"fluid_pp(1)%pv": pv,
# Last fluid_pp is always reserved for bubble gas state ===
# if applicable ==========================================
"fluid_pp(2)%gamma": 1.0 / (gamma_n - 1.0),
"fluid_pp(2)%pi_inf": 0.0e00,
}
)
)
Loading
Loading