Clean up examples folders (#3545)

* Clean up examples folders

* Use `snake_case` names

* Rename `nci_corrector` as `nci_fdtd_stability`

2 files changed, 0 insertions, 263 deletions

diff --git a/Examples/Modules/embedded_boundary_python_API/PICMI_inputs_EB_API.py b/Examples/Modules/embedded_boundary_python_API/PICMI_inputs_EB_API.py
deleted file mode 100755
index c0907d677..000000000
--- a/Examples/Modules/embedded_boundary_python_API/PICMI_inputs_EB_API.py
+++ /dev/null
@@ -1,253 +0,0 @@
-#!/usr/bin/env python3
-import numpy as np
-
-from pywarpx import fields, picmi
-
-max_steps = 1
-unit = 1e-3
-
-##################################
-# Define the mesh
-##################################
-# mesh cells per direction
-nx = 64
-ny = 64
-nz = 64
-
-# mesh bounds for domain
-xmin = -32*unit
-xmax = 32*unit
-ymin = -32*unit
-ymax = 32*unit
-zmin = -32*unit
-zmax = 32*unit
-
-##########################
-# numerics components
-##########################
-lower_boundary_conditions = ['open', 'dirichlet', 'periodic']
-upper_boundary_conditions = ['open', 'dirichlet', 'periodic']
-
-grid = picmi.Cartesian3DGrid(
-    number_of_cells = [nx, ny, nz],
-    lower_bound = [xmin, ymin, zmin],
-    upper_bound = [xmax, ymax, zmax],
-    lower_boundary_conditions = lower_boundary_conditions,
-    upper_boundary_conditions = upper_boundary_conditions,
-    lower_boundary_conditions_particles = ['absorbing', 'absorbing', 'periodic'],
-    upper_boundary_conditions_particles = ['absorbing', 'absorbing', 'periodic'],
-    moving_window_velocity = None,
-    warpx_max_grid_size = 64
-)
-
-
-flag_correct_div = False
-
-solver = picmi.ElectromagneticSolver(grid=grid, method='Yee', cfl=1.)
-
-n_cavity=30
-L_cavity = n_cavity*unit
-
-embedded_boundary = picmi.EmbeddedBoundary(
-    implicit_function="max(max(max(x-L_cavity/2,-L_cavity/2-x),max(y-L_cavity/2,-L_cavity/2-y)),max(z-L_cavity/2,-L_cavity/2-z))",
-    L_cavity=L_cavity
-)
-
-
-##########################
-# diagnostics
-##########################
-
-field_diag = picmi.FieldDiagnostic(
-    name = 'diag1',
-    grid = grid,
-    period = 1,
-    data_list = ['Ex'],
-    write_dir = '.',
-    warpx_file_prefix = "embedded_boundary_python_API_plt"
-)
-
-##########################
-# simulation setup
-##########################
-
-sim = picmi.Simulation(
-    solver = solver,
-    max_steps = max_steps,
-    warpx_embedded_boundary=embedded_boundary,
-    verbose = 1
-)
-
-sim.add_diagnostic(field_diag)
-
-sim.initialize_inputs()
-
-sim.step(1)
-
-print("======== Testing sim.extension.get_mesh_edge_lengths =========")
-
-ly_slice_x = np.array(sim.extension.get_mesh_edge_lengths(0,1,include_ghosts=False)[0])[int(nx/2),:,:]
-lz_slice_x = np.array(sim.extension.get_mesh_edge_lengths(0,2,include_ghosts=False)[0])[int(nx/2),:,:]
-
-n_edge_y_lo = int((ny - 30)/2)
-n_edge_y_hi = int(ny - (ny - 30)/2)
-n_edge_z_lo = int((nz - 30)/2)
-n_edge_z_hi = int(nz - (nz - 30)/2)
-
-perimeter_slice_x = (np.sum(ly_slice_x[n_edge_y_lo:n_edge_y_hi, n_edge_z_lo+1]) +
-                     np.sum(ly_slice_x[n_edge_y_lo:n_edge_y_hi, n_edge_z_hi-1]) +
-                     np.sum(lz_slice_x[n_edge_y_lo+1, n_edge_z_lo:n_edge_z_hi]) +
-                     np.sum(lz_slice_x[n_edge_y_hi-1, n_edge_z_lo:n_edge_z_hi]))
-
-perimeter_slice_x_true = L_cavity*4
-
-print("Perimeter of the middle x-slice:", perimeter_slice_x)
-assert np.isclose(perimeter_slice_x, perimeter_slice_x_true, rtol=1e-05, atol=1e-08)
-
-
-lx_slice_y = np.array(sim.extension.get_mesh_edge_lengths(0,0,include_ghosts=False)[0])[:,int(ny/2),:]
-lz_slice_y = np.array(sim.extension.get_mesh_edge_lengths(0,2,include_ghosts=False)[0])[:,int(ny/2),:]
-
-n_edge_x_lo = int((nx - 30)/2)
-n_edge_x_hi = int(nx - (nx - 30)/2)
-n_edge_z_lo = int((nz - 30)/2)
-n_edge_z_hi = int(nz - (nz - 30)/2)
-
-perimeter_slice_y = (np.sum(lx_slice_y[n_edge_x_lo:n_edge_x_hi, n_edge_z_lo+1]) +
-                     np.sum(lx_slice_y[n_edge_x_lo:n_edge_x_hi, n_edge_z_hi-1]) +
-                     np.sum(lz_slice_y[n_edge_x_lo+1, n_edge_z_lo:n_edge_z_hi]) +
-                     np.sum(lz_slice_y[n_edge_x_hi-1, n_edge_z_lo:n_edge_z_hi]))
-
-perimeter_slice_y_true = L_cavity*4
-
-
-print("Perimeter of the middle y-slice:", perimeter_slice_y)
-assert np.isclose(perimeter_slice_y, perimeter_slice_y_true, rtol=1e-05, atol=1e-08)
-
-
-lx_slice_z = np.array(sim.extension.get_mesh_edge_lengths(0,0,include_ghosts=False)[0])[:,:,int(nz/2)]
-ly_slice_z = np.array(sim.extension.get_mesh_edge_lengths(0,1,include_ghosts=False)[0])[:,:,int(nz/2)]
-
-n_edge_x_lo = int((nx - 30)/2)
-n_edge_x_hi = int(nx - (nx - 30)/2)
-n_edge_y_lo = int((ny - 30)/2)
-n_edge_y_hi = int(ny - (ny - 30)/2)
-
-perimeter_slice_z = (np.sum(lx_slice_z[n_edge_x_lo:n_edge_x_hi, n_edge_y_lo+1]) +
-                     np.sum(lx_slice_z[n_edge_x_lo:n_edge_x_hi, n_edge_y_hi-1]) +
-                     np.sum(ly_slice_z[n_edge_x_lo+1, n_edge_y_lo:n_edge_y_hi]) +
-                     np.sum(ly_slice_z[n_edge_x_hi-1, n_edge_y_lo:n_edge_y_hi]))
-
-perimeter_slice_z_true = L_cavity*4
-
-print("Perimeter of the middle z-slice:", perimeter_slice_z)
-assert np.isclose(perimeter_slice_z, perimeter_slice_z_true, rtol=1e-05, atol=1e-08)
-
-print("======== Testing sim.extension.get_mesh_face_areas =========")
-
-Sx_slice = np.sum(np.array(sim.extension.get_mesh_face_areas(0,0,include_ghosts=False)[0])[int(nx/2),:,:])
-dx = (xmax-xmin)/nx
-Ax = dx*dx
-Sx_slice_true = L_cavity*L_cavity - 2*Ax
-print("Area of the middle x-slice:", Sx_slice)
-assert np.isclose(Sx_slice, Sx_slice_true, rtol=1e-05, atol=1e-08)
-
-
-Sy_slice = np.sum(np.array(sim.extension.get_mesh_face_areas(0,1,include_ghosts=False)[0])[:,int(ny/2),:])
-dy = (ymax-ymin)/ny
-Ay = dy*dy
-Sy_slice_true = L_cavity*L_cavity - 2*Ay
-print("Area of the middle y-slice:", Sx_slice)
-assert np.isclose(Sy_slice, Sy_slice_true, rtol=1e-05, atol=1e-08)
-
-
-Sz_slice = np.sum(np.array(sim.extension.get_mesh_face_areas(0,2,include_ghosts=False)[0])[:,:,int(nz/2)])
-dz = (zmax-zmin)/nz
-Az = dz*dz
-Sz_slice_true = L_cavity*L_cavity - 2*Az
-print("Area of the middle z-slice:", Sz_slice)
-assert np.isclose(Sz_slice, Sz_slice_true, rtol=1e-05, atol=1e-08)
-
-print("======== Testing the wrappers of m_edge_lengths =========")
-
-ly_slice_x = np.array(fields.EdgeLengthsyWrapper().get_fabs(0,1,include_ghosts=False)[0])[int(nx/2),:,:]
-lz_slice_x = np.array(fields.EdgeLengthszWrapper().get_fabs(0,2,include_ghosts=False)[0])[int(nx/2),:,:]
-
-n_edge_y_lo = int((ny - 30)/2)
-n_edge_y_hi = int(ny - (ny - 30)/2)
-n_edge_z_lo = int((nz - 30)/2)
-n_edge_z_hi = int(nz - (nz - 30)/2)
-
-perimeter_slice_x = (np.sum(ly_slice_x[n_edge_y_lo:n_edge_y_hi, n_edge_z_lo+1]) +
-                     np.sum(ly_slice_x[n_edge_y_lo:n_edge_y_hi, n_edge_z_hi-1]) +
-                     np.sum(lz_slice_x[n_edge_y_lo+1, n_edge_z_lo:n_edge_z_hi]) +
-                     np.sum(lz_slice_x[n_edge_y_hi-1, n_edge_z_lo:n_edge_z_hi]))
-
-perimeter_slice_x_true = L_cavity*4
-
-print("Perimeter of the middle x-slice:", perimeter_slice_x)
-assert np.isclose(perimeter_slice_x, perimeter_slice_x_true, rtol=1e-05, atol=1e-08)
-
-
-lx_slice_y = np.array(fields.EdgeLengthsxWrapper().get_fabs(0,0,include_ghosts=False)[0])[:,int(ny/2),:]
-lz_slice_y = np.array(fields.EdgeLengthszWrapper().get_fabs(0,2,include_ghosts=False)[0])[:,int(ny/2),:]
-
-n_edge_x_lo = int((nx - 30)/2)
-n_edge_x_hi = int(nx - (nx - 30)/2)
-n_edge_z_lo = int((nz - 30)/2)
-n_edge_z_hi = int(nz - (nz - 30)/2)
-
-perimeter_slice_y = (np.sum(lx_slice_y[n_edge_x_lo:n_edge_x_hi, n_edge_z_lo+1]) +
-                     np.sum(lx_slice_y[n_edge_x_lo:n_edge_x_hi, n_edge_z_hi-1]) +
-                     np.sum(lz_slice_y[n_edge_x_lo+1, n_edge_z_lo:n_edge_z_hi]) +
-                     np.sum(lz_slice_y[n_edge_x_hi-1, n_edge_z_lo:n_edge_z_hi]))
-
-perimeter_slice_y_true = L_cavity*4
-
-
-print("Perimeter of the middle y-slice:", perimeter_slice_y)
-assert np.isclose(perimeter_slice_y, perimeter_slice_y_true, rtol=1e-05, atol=1e-08)
-
-
-lx_slice_z = np.array(fields.EdgeLengthsxWrapper().get_fabs(0,0,include_ghosts=False)[0])[:,:,int(nz/2)]
-ly_slice_z = np.array(fields.EdgeLengthsyWrapper().get_fabs(0,1,include_ghosts=False)[0])[:,:,int(nz/2)]
-
-n_edge_x_lo = int((nx - 30)/2)
-n_edge_x_hi = int(nx - (nx - 30)/2)
-n_edge_y_lo = int((ny - 30)/2)
-n_edge_y_hi = int(ny - (ny - 30)/2)
-
-perimeter_slice_z = (np.sum(lx_slice_z[n_edge_x_lo:n_edge_x_hi, n_edge_y_lo+1]) +
-                     np.sum(lx_slice_z[n_edge_x_lo:n_edge_x_hi, n_edge_y_hi-1]) +
-                     np.sum(ly_slice_z[n_edge_x_lo+1, n_edge_y_lo:n_edge_y_hi]) +
-                     np.sum(ly_slice_z[n_edge_x_hi-1, n_edge_y_lo:n_edge_y_hi]))
-
-perimeter_slice_z_true = L_cavity*4
-
-print("Perimeter of the middle z-slice:", perimeter_slice_z)
-assert np.isclose(perimeter_slice_z, perimeter_slice_z_true, rtol=1e-05, atol=1e-08)
-
-print("======== Testing the wrappers of m_face_areas =========")
-
-Sx_slice = np.sum(np.array(fields.FaceAreasxWrapper().get_fabs(0,0,include_ghosts=False)[0])[int(nx/2),:,:])
-dx = (xmax-xmin)/nx
-Ax = dx*dx
-Sx_slice_true = L_cavity*L_cavity - 2*Ax
-print("Area of the middle x-slice:", Sx_slice)
-assert np.isclose(Sx_slice, Sx_slice_true, rtol=1e-05, atol=1e-08)
-
-Sy_slice = np.sum(np.array(fields.FaceAreasyWrapper().get_fabs(0,1,include_ghosts=False)[0])[:,int(ny/2),:])
-dy = (ymax-ymin)/ny
-Ay = dy*dy
-Sy_slice_true = L_cavity*L_cavity - 2*Ay
-print("Area of the middle y-slice:", Sx_slice)
-assert np.isclose(Sy_slice, Sy_slice_true, rtol=1e-05, atol=1e-08)
-
-Sz_slice = np.sum(np.array(fields.FaceAreaszWrapper().get_fabs(0,2,include_ghosts=False)[0])[:,:,int(nz/2)])
-dz = (zmax-zmin)/nz
-Az = dz*dz
-Sz_slice_true = L_cavity*L_cavity - 2*Az
-print("Area of the middle z-slice:", Sz_slice)
-assert np.isclose(Sz_slice, Sz_slice_true, rtol=1e-05, atol=1e-08)
-
-sim.step(1)
diff --git a/Examples/Modules/embedded_boundary_python_API/analysis.py b/Examples/Modules/embedded_boundary_python_API/analysis.py
deleted file mode 100755
index 09cc2accf..000000000
--- a/Examples/Modules/embedded_boundary_python_API/analysis.py
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/usr/bin/env python3
-
-# This script just checks that the PICMI file executed successfully.
-# If it did there will be a plotfile for the final step.
-
-import sys
-
-step = int(sys.argv[1][-5:])
-
-assert step == 2