Add external particle fields ohms law hybrid

Docs/source/refs.bib

@@ -507,3 +507,13 @@ @article{Rhee1987
     url = {https://doi.org/10.1063/1.1139314},
     eprint = {https://pubs.aip.org/aip/rsi/article-pdf/58/2/240/19154912/240\_1\_online.pdf},
 }
+
+@misc{holmstrom2013handlingvacuumregionshybrid,
+      title={Handling vacuum regions in a hybrid plasma solver},
+      author={M. Holmstrom},
+      year={2013},
+      eprint={1301.0272},
+      archivePrefix={arXiv},
+      primaryClass={physics.space-ph},
+      url={https://arxiv.org/abs/1301.0272},
+}

Docs/source/usage/parameters.rst

@@ -2535,6 +2535,27 @@ Maxwell solver: kinetic-fluid hybrid
 * ``hybrid_pic_model.substeps`` (`int`) optional (default ``10``)
     If ``algo.maxwell_solver`` is set to ``hybrid``, this sets the number of sub-steps to take during the B-field update.
 
+* ``hybrid_pic_model.holmstrom_vacuum_region`` (`bool`) optional (default ``false``)
+    If ``algo.maxwell_solver`` is set to ``hybrid``, this sets the vacuum region handling of the generalized Ohm's Law to suppress vacuum fluctuations. :cite:t:`param-holmstrom2013handlingvacuumregionshybrid`.
+
+* ``hybid_pic_model.add_external_fields`` (`bool`) optional (default ``false``)
+    If ``algo.maxwell_solver`` is set to ``hybrid``, this sets the hybrid solver to use split external fields defined in external_vector_potential inputs.
+
+* ``external_vector_potential.fields`` (list of `str`) optional (default ``empty``)
+    If ``hybid_pic_model.add_external_fields`` is set to ``true``, this adds a list names for external time varying vector potentials to be added to hybrid solver.
+
+* ``external_vector_potential.<field name>.read_from_file`` (`bool`) optional (default ``false``)
+    If ``hybid_pic_model.add_external_fields`` is set to ``true``, this flag determines whether to load an external field or use an implcit function to evaluate teh time varying field.
+
+* ``external_vector_potential.<field name>.path`` (`str`) optional (default ``""``)
+    If ``external_vector_potential.<field name>.read_from_file`` is set to ``true``, sets the path to an OpenPMD file that can be loaded externally in :math:`weber/m`.
+
+* ``external_vector_potential.<field name>.A[x,y,z]_external_grid_function(x,y,z)`` (`str`) optional (default ``"0"``)
+    If ``external_vector_potential.<field name>.read_from_file`` is set to ``false``, Sets the external vector potential to be populated by an implicit function (on the grid) in :math:`weber/m`.
+
+* ``external_vector_potential.<field name>.A_time_external_grid_function(t)`` (`str`) optional (default ``"1"``)
+    This sets the relative strength of the external vector potential by a dimensionless implicit time function, which can compute the external B fields and E fields based on the value and first time derivative of the function.
+
 .. note::
 
     Based on results from :cite:t:`param-Stanier2020` it is recommended to use

Examples/Tests/CMakeLists.txt

@@ -41,6 +41,7 @@ add_subdirectory(nci_fdtd_stability)
 add_subdirectory(nci_psatd_stability)
 add_subdirectory(nodal_electrostatic)
 add_subdirectory(nuclear_fusion)
+add_subdirectory(ohm_solver_cylinder_compression)
 add_subdirectory(ohm_solver_em_modes)
 add_subdirectory(ohm_solver_ion_beam_instability)
 add_subdirectory(ohm_solver_ion_Landau_damping)

Examples/Tests/ohm_solver_cylinder_compression/CMakeLists.txt

@@ -0,0 +1,24 @@
+# Add tests (alphabetical order) ##############################################
+#
+
+add_warpx_test(
+    test_3d_ohm_solver_cylinder_compression_picmi  # name
+    3  # dims
+    2  # nprocs
+    "inputs_test_3d_ohm_solver_cylinder_compression_picmi.py --test"  # inputs
+    analysis_default_regression.py  # analysis
+    diags/diag1000020  # output
+    OFF  # dependency
+)
+label_warpx_test(test_3d_ohm_solver_cylinder_compression_picmi slow)
+
+add_warpx_test(
+    test_rz_ohm_solver_cylinder_compression_picmi  # name
+    RZ  # dims
+    2  # nprocs
+    "inputs_test_rz_ohm_solver_cylinder_compression_picmi.py --test"  # inputs
+    analysis_default_regression.py  # analysis
+    diags/diag1000020  # output
+    OFF  # dependency
+)
+label_warpx_test(test_rz_ohm_solver_cylinder_compression_picmi slow)

Examples/Tests/ohm_solver_cylinder_compression/analysis_default_regression.py

@@ -0,0 +1 @@
+../../analysis_default_regression.py