released v1.0.1 - added an example and a test file to show how to com…

…pute the MGF in spectral domain
modelics · Mar 13, 2022 · d99ef48 · d99ef48
1 parent bd2ddcb
commit d99ef48
Show file tree

Hide file tree

Showing 20 changed files with 3,148 additions and 1,508 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+Changes to Strata are listed in this file.
+
+## [1.0.1] - 2022-03-13
+
+- Added another example with digitized data from Yuan, Sarkar, Salazar-Palma, TMTT, 2006; modified `testMGF.cpp` accordingly.
+- Added `testSpectralMGF.cpp` to demonstrate how Strata can be used to compute the MGF in spectral (spatial frequency) domain.
+- Modified the default Sommerfeld integration path deformation height above the real axis based on experimentation.
+- Modified README to include a section on related projects by other authors.
+
+## [1.0.0] - 2021-11-08
+
+- Initial release of Strata
diff --git a/README.md b/README.md
@@ -121,6 +121,12 @@ We also encourage users to help in our goal of providing a high-quality library
 
 * These comments also apply to the lower half-space.
 
+## Related Projects
+
+This is a list of related open-source projects by other authors - please let us know if some projects were missed.
+
+* A Matlab and Fortran library for computing the MGF for the case of two half spaces can be found [here](https://github.com/UniPD-DII-ETCOMP/Half_Space_Green_A_Phi).
+
 ## References
 
 <a name="mgf01"></a>[1] K. A. Michalski and D. Zheng, "Electromagnetic scattering and radiation by surfaces of arbitrary shape in layered media. I. theory," *IEEE Trans. Antennas Propag.*, vol. 38, no. 3, pp. 335–344, Mar. 1990.

diff --git a/doc/strata.pdf b/doc/strata.pdf
diff --git a/inc/sommerfeld_integrals.hpp b/inc/sommerfeld_integrals.hpp
@@ -204,8 +204,10 @@ inline std::complex<double> IntegrateSpectralNearField(SpectralMGF &smgf, double
 
 	const std::complex<double> J (0.0, 1.0);
 
-	double h = 1.0e-2*std::abs(smgf.lm->k_max);
-	// double h = 1.0e-3*std::abs(smgf.lm->k_max);
+	// Different problems seem to require different settings for h. A more robust way to pick it would be useful.
+
+	// double h = 1.0e-2*std::abs(smgf.lm->k_max);
+	double h = 1.0e-3*std::abs(smgf.lm->k_max);
 	// double h = 1.0e-1*std::abs(smgf.lm->k_max);
 	double krho_real, krho_imag;
 

diff --git a/src/layers.cpp b/src/layers.cpp
@@ -46,7 +46,7 @@ using namespace strata;
 // Interface - layer management
 // ==================================================================================
 
-/*! \brief Function to parse a given technology file and populate layer data.*/
+/*! \brief Function to parse a given technology file and populate layer data. Note that the argument "units" is only used if the tech file is in the (deprecated) .tech format.*/
 void LayerManager::ProcessTechFile(std::string tech_file, double units)
 {
 

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -46,4 +46,7 @@ add_executable(testSingularity ${SRC_DIR}/testSingularity.cpp)
 target_include_directories(testSingularity PRIVATE ${INC_DIR} ${STRATA_INC})
 target_link_libraries(testSingularity ${STRATA_LIB})
 
+add_executable(testSpectralMGF ${SRC_DIR}/testSpectralMGF.cpp)
+target_include_directories(testSpectralMGF PRIVATE ${INC_DIR} ${STRATA_INC})
+target_link_libraries(testSpectralMGF ${STRATA_LIB})
 
diff --git a/test/examples/ling_jin_2000/MGFdata.txt b/test/examples/ling_jin_2000/MGFdata.txt
diff --git a/test/examples/ling_jin_2000/MGFdata_interp.txt b/test/examples/ling_jin_2000/MGFdata_interp.txt
diff --git a/test/examples/ling_jin_2000/MGFdata_singularity.txt b/test/examples/ling_jin_2000/MGFdata_singularity.txt
diff --git a/test/examples/yuan_sarkar_salazar-palma_2006/MGFdata.txt b/test/examples/yuan_sarkar_salazar-palma_2006/MGFdata.txt