SyTen
syten::Krylov::Evolution::Conf Struct Reference

The Conf struct stores info on how to evolve the state. More...

#include <krylov_evolve.h>

+ Inheritance diagram for syten::Krylov::Evolution::Conf:
+ Collaboration diagram for syten::Krylov::Evolution::Conf:

Public Member Functions

 Conf ()=default
 default constructor, leaving tbeg, tend and dt uninitialized More...
 
 Conf (SDef tend_, SDef dt_=0.01_r, SDef tbeg_=0_r)
 Conf constructor for simple configuration. should be used to set tbeg, tend and dt, as it tests that we can actually reach tend by adding dt to tbeg. More...
 
- Public Member Functions inherited from syten::IterativeConfig
 IterativeConfig (SRDef errTolerance_, SRDef inxTolerance_, Index maxIter_, Index minIter_, Index stepSolver_, Index maxGainlessSteps_, char mode_, char submode_)
 Standard ctor, because gcc 4.9.2 does not like braced init lists. More...
 
template<typename Archive >
void serialize (Archive &ar, const unsigned int in_version)
 Standard serialisation function. More...
 
- Public Member Functions inherited from syten::Truncation
bool notTruncating () const
 Returns true if *this corresponds to no truncation, i.e. More...
 
template<typename Truncatable >
SRDef operator() (Truncatable &&s) const
 Calls truncateKeepNorm() on the passed argument with *this as an argument. More...
 
bool operator== (Truncation const &other) const
 Returns true if *this is exactly equal to other More...
 
bool operator> (Truncation const &other) const
 Returns true if any parameter of *this defines a stronger truncation (resulting in a potentially smaller state space) than the corresponding operator in other. More...
 
void scale (SRDef const norm)
 Scales *this to be correct for a tensor of norm n as opposed to norm 1. More...
 
Truncation scaled (SRDef const norm) const
 Copies *this, scales the copy to be correct for a tensor of norm n and returns the scaled object. More...
 
template<typename Archive >
void serialize (Archive &ar, unsigned int const in_version)
 Boost serialisation. More...
 
 Truncation (SRDef const threshold_=-1, Index const maxStates_=Maximum(), Index const maxBlocksize_=Maximum(), SRDef const weight_=-1)
 Standard ctor, works with 0 through 3 arguments. More...
 

Public Attributes

SDef dt = 0_r
 step size in time propagation More...
 
std::string filename = ""
 filename to eventually save final state to More...
 
Index normaliseInterval = std::numeric_limits<Index>::max()
 normalise after this number of steps More...
 
std::string prefix = "krylov"
 prefix to save location More...
 
char recyclingHeuristic = 'C'
 identifies the heuristic to use in recyling of subspace More...
 
Index saveInterval =1
 save each saveInterval'th time step More...
 
bool store_krylov_subspace = false
 stores krylov subspace objects in krylov evolver More...
 
SDef tbeg = 0_r
 where to begin time propagation More...
 
SDef tend = 0_r
 where to end time propagation More...
 
bool truncate_vectors_m = false
 if true, truncate the intermediate Krylov vectors according to some maximal bond dimension. More...
 
- Public Attributes inherited from syten::IterativeConfig
SRDef errTolerance {SYTEN_SMALL_THRESHOLD}
 Allowed error tolerance, e.g. More...
 
SRDef inxTolerance {1000 * SYTEN_SMALL_THRESHOLD}
 Allowed error from inexact arithmetic, e.g. More...
 
Index maxGainlessSteps {5}
 Maximal number of steps without gain. More...
 
Index maxIter {8}
 Maximal number of iterations. More...
 
Index minIter {2}
 Minimal number of iterations. More...
 
char mode {'C'}
 The mode of operation, see modes_help for documentation. More...
 
Index stepSolver {2}
 Check progress every stepSolver'th step. More...
 
char submode {'a'}
 Submode, primarily used for re-orthogonalisation configuration, see submodes_help for documentation. More...
 
- Public Attributes inherited from syten::Truncation
Index maxBlocksize {Maximum()}
 maximal blocksize of each dense block More...
 
Index maxStates {Maximum()}
 maximal number of states to keep More...
 
SRDef threshold {-1}
 Singular value threshold. More...
 
bool truncate_to_convergence {false}
 If true, truncate repeatedly until the bond dimension no longer changes. More...
 
SRDef weight {-1}
 Maximal discarded weight, given by \( \sum_{\mathrm{disc}} s_i^2 \). More...
 

Additional Inherited Members

- Static Public Attributes inherited from syten::IterativeConfig
static std::string evolve_modes_help
 Static string describing the available modes. More...
 
static std::string evolve_submodes_help
 Static string describing the available sub-modes. More...
 
static std::string simple_modes_help
 Static string describing the available modes. More...
 
static std::string simple_submodes_help
 Static string describing the available sub-modes. More...
 
static constexpr unsigned int version = 2
 Bump this if the above changes. More...
 
- Static Public Attributes inherited from syten::Truncation
static constexpr unsigned int version = 2
 Boost serialisation version. More...
 

Detailed Description

The Conf struct stores info on how to evolve the state.


The documentation for this struct was generated from the following file: