Skip to content
Snippets Groups Projects
Commit b0626202 authored by Cristian Lalescu's avatar Cristian Lalescu
Browse files

add documentation

parent 7637bc86
No related branches found
No related tags found
No related merge requests found
...@@ -36,6 +36,19 @@ ...@@ -36,6 +36,19 @@
#include "field_binary_IO.hpp" #include "field_binary_IO.hpp"
#include "full_code/NSVE_field_stats.hpp" #include "full_code/NSVE_field_stats.hpp"
/** \brief A class for running bandpass statistics.
*
* This class computes statistics for a particular type of filter.
* Given a list of pairs of length-scales, the velocity field is filtered
* with a band-pass filter for each pair of length scales, and standard
* statistics of the band-passed field are computed.
* Relevant publication:
* Drivas, T. D. and Johnson, P. L. and Lalescu, C. C. and Wilczek, M. Phys Rev Fluids 2 104603 (2017)
* https://dx.doi.org/10.1103/PhysRevFluids.2.104603
* Not all statistics discussed in the paper are performed here, but the
* existing code can be expanded if needed.
*/
template <typename rnumber> template <typename rnumber>
class bandpass_stats: public NSVE_field_stats<rnumber> class bandpass_stats: public NSVE_field_stats<rnumber>
{ {
...@@ -44,6 +57,7 @@ class bandpass_stats: public NSVE_field_stats<rnumber> ...@@ -44,6 +57,7 @@ class bandpass_stats: public NSVE_field_stats<rnumber>
int niter_out; int niter_out;
double max_velocity_estimate; double max_velocity_estimate;
kspace<FFTW, SMOOTH> *kk; kspace<FFTW, SMOOTH> *kk;
/* parameters that are read in read_parameters */
std::vector<double> k0list, k1list; std::vector<double> k0list, k1list;
std::string filter_type; std::string filter_type;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment