solver.hpp

Go to the documentation of this file.

#ifndef SOLVER_HPP
#define SOLVER_HPP
 
#include "plasma.hpp"
#include "electric_field.hpp"
#include "perturbed_B_field.hpp"
#include "charge.hpp"
#include "sml.hpp"
#include "solver_settings.hpp"
#include "step_trigger.hpp"
#include "simple00_solver.hpp"
#include "bias_potential.hpp"
#include "setup_solver_boundaries.hpp"
#include "solver_init_data.hpp"
 
// Base class for solvers
class Solver{
 
    public:
 
    enum SOLVER_INT : int {A=0, A_SPEC, A_CV, A_CV_SPEC, P0, H, H_SPEC};
 
    std::string label;
    StepTrigger update_trigger;
    bool initialized;
 
    int solver_index; // Used for fortran accesses
    int spec_solver_index; // Used for fortran accesses (spectral)
 
    bool spectral;
    int n_rhs;
 
    int n_triangle;
 
    Boundary bd_rhs; // Boundary for input (charge, current)
    Boundary bd; // Boundary for solution (potential)
 
    bool use_pade;
 
    Solver(std::string label_in, int solver_index_in, int spec_solver_index_in, bool spectral_in, int n_rhs_in, int n_triangle_in, bool use_pade_in, bool update_solver, int update_solver_nstep);
 
    bool update_is_triggered(int gstep) const;
 
    void update_helm_solver(int isolver, const SolverInitData<HostType>& solver_data, const View<int*,CLayout,HostType>& bd,
                        const View<double*,CLayout,HostType>& alpha,
                        const View<double*,CLayout,HostType>& beta);
 
    void update(const SolverInitData<HostType>& solver_data, const View<int*,CLayout,DeviceType>& bd_d);
 
    // Virtual functions: Default exists but can be overridden
    virtual void rhs1_set_alpha_beta(const SolverInitData<HostType>& solver_data, double scale, const View<double*,CLayout,HostType>& alpha, const View<double*,CLayout,HostType>& beta);
    virtual void rhs2_set_alpha_beta(const SolverInitData<HostType>& solver_data, double scale, const View<double*,CLayout,HostType>& alpha, const View<double*,CLayout,HostType>& beta);
    virtual void iter_solver_set_alpha_beta(const SolverInitData<HostType>& solver_data, const View<double*,CLayout,HostType>& alpha, const View<double*,CLayout,HostType>& beta);
 
    virtual ~Solver() = default;
 
    // Pure virtual functions: Must be defined for each solver
    virtual void lhs_set_alpha_beta(const SolverInitData<HostType>& solver_data, const View<double*,CLayout,HostType>& alpha, const View<double*,CLayout,HostType>& beta, double& scale) = 0;
    virtual void setup_boundaries(NLReader::NamelistReader& nlr, bool is_XGCa, bool explicit_electromagnetic, const MagneticField<DeviceType>& magnetic_field, const Grid<DeviceType>& grid) = 0;
};
 
#endif