+
2#include "asgard_tools.hpp"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
70 fokkerplanck_1d_pitch_E_case1,
+
71 fokkerplanck_1d_pitch_E_case2,
+
72 fokkerplanck_1d_pitch_C,
+
+
+
+
76 fokkerplanck_2d_complete_case1,
+
77 fokkerplanck_2d_complete_case2,
+
78 fokkerplanck_2d_complete_case3,
+
79 fokkerplanck_2d_complete_case4,
+
+
+
+
+
+
+
+
+
+
+
90 collisional_landau_1x2v,
+
91 collisional_landau_1x3v
+
+
+
+
101enum class PDE_case_opts
+
+
+
+
+
+
+
+
+
+
+
+
+
+
140namespace time_advance
+
+
+
+
+
+
+
+
+
175int constexpr novalue = -1;
+
180double constexpr notolerance = -1.0;
+
+
+
+
+
194 explicit vecstrview(std::vector<std::string_view>
const &
s) : s_(
s)
+
+
+
197 operator std::vector<std::string_view>
const &()
const {
return s_; }
+
+
199 std::vector<std::string_view>
const &s_;
+
+
+
+
+
214 split_views(std::vector<std::string> &&
own)
+
+
+
217 views_.reserve(own_.size() + 1);
+
218 views_.push_back(
"test");
+
+
+
+
222 operator std::vector<std::string_view>
const &()
+
+
+
+
226 operator vecstrview
const &()
+
+
+
+
230 std::vector<std::string> own_;
+
231 std::vector<std::string_view> views_;
+
+
+
+
249split_views split_argv(std::string_view
const &
opts);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
383 std::optional<double>
dt;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
443 bool ignore_unknown =
true);
+
+
+
+
+
+
449 process_file(
"<executable>");
+
+
+
+
+
+
+
455 process_inputs(
argv, handle_mode::ignore_unknown);
+
+
+
+
459 template<
typename out_type>
+
+
460 std::optional<out_type>
file_value(std::string_view
const &
s)
const
+
+
+
+
+
465 template<
typename out_type>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
500 isol_outer_iterations,
+
+
+
503 enum class handle_mode
+
+
+
+
+
+
+
511 std::filesystem::path infile;
+
+
514 std::vector<std::string> filedata;
+
516 void process_file(std::string_view
const &
exec_name);
+
+
519 void process_inputs(std::vector<std::string_view>
const &
argv,
+
+
522 static std::optional<PDE_opts> get_pde_opt(std::string_view
const &
pde_str);
+
+
525 static std::vector<int> parse_ints(std::string
const &
number_string)
+
+
+
+
+
+
+
+
+
+
+
+
537 size_t pos =
word.find_first_of(
'\"');
+
538 if (
pos != std::string::npos)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
556 template<
typename out_type>
+
557 std::optional<out_type> get_val(std::vector<std::string>
const &
strs,
+
558 std::string_view
const &
s)
const
+
+
560 static_assert(std::is_same_v<out_type, int>
or std::is_same_v<out_type, bool>
+
561 or std::is_same_v<out_type, float>
or std::is_same_v<out_type, double>
+
562 or std::is_same_v<out_type, std::string>,
+
563 "prog_opts can only process: int, float, double, bool or string");
+
564 for (
size_t i = 0;
i <
strs.size();
i += 2)
+
+
+
+
568 if (
i + 1 ==
strs.size())
+
+
570 const std::string &
val =
strs[
i + 1];
+
571 if constexpr (std::is_same_v<out_type, std::string>)
+
+
573 else if constexpr (std::is_same_v<out_type, int>)
+
574 return std::stoi(
val);
+
575 else if constexpr (std::is_same_v<out_type, double>)
+
576 return std::stod(
val);
+
577 else if constexpr (std::is_same_v<out_type, float>)
+
578 return std::stof(
val);
+
579 else if constexpr (std::is_same_v<out_type, bool>)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
596 static std::string vect_to_str(std::vector<int>
const &
ints)
+
+
+
+
+
+
+
+
+
+
611inline prog_opts make_opts(std::string
const &
cli)
+
+
613 return prog_opts(split_argv(
cli));
+
+
+
+
+
+
std::ostream & operator<<(std::ostream &os, prog_opts const &options)
overload for writing options to a stream
Definition asgard_program_options.hpp:617
+
method
Definition asgard_program_options.hpp:147
+
adapt_norm
Definition asgard_program_options.hpp:162
+
kronmult_mode
Indicates whether we should be using sparse or dense kronmult.
Definition asgard_program_options.hpp:119
+
verbosity_level
Allows reducing the amount of cout-noise.
Definition asgard_program_options.hpp:35
+
grid_type
Type of discretization grid.
Definition asgard_program_options.hpp:131
+
solve_opts
the available solvers for implicit time stepping
Definition asgard_program_options.hpp:47
+
PDE_opts
list of builtin PDE specifications, refer to the specs in the src/pde folder
Definition asgard_program_options.hpp:63
+
@ imex
implicit-explicit scheme for nonlinear Vlasov-Poisson problems
+
@ imp
implicit solve, backward Euler
+
@ exp
(default) explicit Runge–Kutta
+
@ l2
L-2 norm.
Definition asgard_program_options.hpp:164
+
@ linf
L-inf norm, a.k.a., max or sup norm.
Definition asgard_program_options.hpp:166
+
@ dense
Using a dense matrix (assumes everything is connected).
+
@ sparse
Using a sparse matrix (checks for connectivity).
+
@ quiet
do not generate cout output, except on errors and important warnings
+
@ high
provide a detailed log of the various aspects of the simulation
+
@ mixed
Dense tensor of two sparse grids.
+
@ scalapack
distributed direct solver, MPI-powered alternative to LAPACK
+
@ direct
direct solve using LAPACK, slow but stable
+
@ gmres
popular iterative solver, can be sensitive to the tolerance and restart frequency
+
@ bicgstab
alternative to gmres, cheaper when taking many steps between restarts
+
auto discretize(prog_opts const &options, verbosity_level verbosity=verbosity_level::quiet)
Creates a discretization for the given pde and options.
Definition asgard.hpp:92
+
Reads options from the command line and input files.
Definition asgard_program_options.hpp:354
+
std::optional< int > wavelet_output_freq
output frequency of wavelet data used for restarts or python plotting
Definition asgard_program_options.hpp:391
+
bool ignore_exact
indicates if the exact solution should be ignored or the error computed and shown every time-step
Definition asgard_program_options.hpp:419
+
prog_opts()=default
create empty options, allows to manually fill the options later
+
std::optional< int > memory_limit
local kron method only, sparse mode, keeps less data on the device
Definition asgard_program_options.hpp:405
+
std::optional< int > num_time_steps
number of fixed time steps to take
Definition asgard_program_options.hpp:385
+
std::optional< int > degree
degree of the polynomial basis
Definition asgard_program_options.hpp:373
+
static void print_help(std::ostream &os=std::cout)
print list of ASGarD specific options
+
prog_opts(std::filesystem::path const &filename)
process from a file
Definition asgard_program_options.hpp:446
+
std::optional< kronmult_mode > kron_mode
local kron method only, mode dense or sparse (faster but memory hungry)
Definition asgard_program_options.hpp:403
+
std::optional< out_type > file_value(std::string_view const &s) const
read an extra option from a file
Definition asgard_program_options.hpp:460
+
std::string start_levels_str() const
converts the start_levels to a human readable string
Definition asgard_program_options.hpp:434
+
std::optional< bool > set_electric
enable/disable the Poisson solver
Definition asgard_program_options.hpp:388
+
std::vector< int > max_levels
read from -max_levels
Definition asgard_program_options.hpp:366
+
std::optional< double > dt
fixed time step, if missing the default cfl condition will be used
Definition asgard_program_options.hpp:383
+
std::string title
if provided, the title helps organize projects with multiple files
Definition asgard_program_options.hpp:356
+
std::optional< adapt_norm > anorm
adaptivity norm, either l2 or linf
Definition asgard_program_options.hpp:378
+
std::optional< int > isolver_outer_iterations
max number of output gmres iterations
Definition asgard_program_options.hpp:400
+
std::string subtitle
if provided, the subtitile is an addition to the main title
Definition asgard_program_options.hpp:358
+
std::filesystem::path outfile
filename for the last time step
Definition asgard_program_options.hpp:410
+
std::string max_levels_str() const
converts the max_levels to a human readable string
Definition asgard_program_options.hpp:436
+
static void print_version_help(std::ostream &os=std::cout)
print version and build (cmake) options
+
std::optional< out_type > extra_cli_value(std::string_view const &s) const
read an extra option from the cli extras
Definition asgard_program_options.hpp:466
+
bool show_help
indicates if the –help option was selected
Definition asgard_program_options.hpp:413
+
prog_opts(vecstrview const &argv)
for testing purposes, can read from manually specified argc/argv
Definition asgard_program_options.hpp:453
+
bool show_pde_help
indicates if the -pde? options was selected
Definition asgard_program_options.hpp:417
+
std::optional< solve_opts > solver
solver for implicit or imex methods: direct, gmres, bicgstab
Definition asgard_program_options.hpp:394
+
std::optional< double > adapt_threshold
if set, enables grid adaptivity and provides the tolerance threshold
Definition asgard_program_options.hpp:376
+
std::vector< std::string > externals
argv input values unrecognized by ASGarD
Definition asgard_program_options.hpp:431
+
std::optional< time_advance::method > step_method
time stepping method, explicit, implicit or imex
Definition asgard_program_options.hpp:381
+
std::optional< int > isolver_iterations
max number of iterations (inner iterations for gmres)
Definition asgard_program_options.hpp:398
+
std::optional< double > isolver_tolerance
tolerance for the iterative solvers (gmres, bicgstab)
Definition asgard_program_options.hpp:396
+
static void print_pde_help(std::ostream &os=std::cout)
print information about the builtin PDEs
+
void print_options(std::ostream &os=std::cout) const
print the current set of options
+
std::vector< int > start_levels
read from -start_levels
Definition asgard_program_options.hpp:364
+
prog_opts(int const argc, char const *const *argv, bool ignore_unknown=true)
process the command line arguments, may yield warning if encountering unknown options
+
std::string restart_file
restart the simulation from a file
Definition asgard_program_options.hpp:408
+
bool show_version
indicates if the –version option was selected
Definition asgard_program_options.hpp:415
+
std::optional< grid_type > grid
sparse, dense or mixed grid
Definition asgard_program_options.hpp:369
+
std::optional< int > mgrid_group
if using mixed group, the size of the first mixed group
Definition asgard_program_options.hpp:371
+
std::optional< PDE_opts > pde_choice
if set, one of the builtin PDEs will be used, keep unset for custom PDE projects
Definition asgard_program_options.hpp:361
+
+ 1.9.8
+ 
+
+ 
');
+}
+
+function showSyncOn(n,relpath)
+{
+ n.html('
');
+}
+
+function toggleSyncButton(relpath)
+{
+ var navSync = $('#nav-sync');
+ if (navSync.hasClass('sync')) {
+ navSync.removeClass('sync');
+ showSyncOff(navSync,relpath);
+ storeLink(stripPath2(pathName())+hashUrl());
+ } else {
+ navSync.addClass('sync');
+ showSyncOn(navSync,relpath);
+ deleteLink();
+ }
+}
+
+var loadTriggered = false;
+var readyTriggered = false;
+var loadObject,loadToRoot,loadUrl,loadRelPath;
+
+$(window).on('load',function(){
+ if (readyTriggered) { // ready first
+ navTo(loadObject,loadToRoot,loadUrl,loadRelPath);
+ showRoot();
+ }
+ loadTriggered=true;
+});
+
+function initNavTree(toroot,relpath)
+{
+ var o = new Object();
+ o.toroot = toroot;
+ o.node = new Object();
+ o.node.li = document.getElementById("nav-tree-contents");
+ o.node.childrenData = NAVTREE;
+ o.node.children = new Array();
+ o.node.childrenUL = document.createElement("ul");
+ o.node.getChildrenUL = function() { return o.node.childrenUL; };
+ o.node.li.appendChild(o.node.childrenUL);
+ o.node.depth = 0;
+ o.node.relpath = relpath;
+ o.node.expanded = false;
+ o.node.isLast = true;
+ o.node.plus_img = document.createElement("span");
+ o.node.plus_img.className = 'arrow';
+ o.node.plus_img.innerHTML = arrowRight;
+
+ if (localStorageSupported()) {
+ var navSync = $('#nav-sync');
+ if (cachedLink()) {
+ showSyncOff(navSync,relpath);
+ navSync.removeClass('sync');
+ } else {
+ showSyncOn(navSync,relpath);
+ }
+ navSync.click(function(){ toggleSyncButton(relpath); });
+ }
+
+ if (loadTriggered) { // load before ready
+ navTo(o,toroot,hashUrl(),relpath);
+ showRoot();
+ } else { // ready before load
+ loadObject = o;
+ loadToRoot = toroot;
+ loadUrl = hashUrl();
+ loadRelPath = relpath;
+ readyTriggered=true;
+ }
+
+ $(window).bind('hashchange', function(){
+ if (window.location.hash && window.location.hash.length>1){
+ var a;
+ if ($(location).attr('hash')){
+ var clslink=stripPath(pathName())+':'+hashValue();
+ a=$('.item a[class$="'+clslink.replace(/
+
+
+
+
+
+
+
+