cosmos_d.h

Go to the documentation of this file.

 
 #ifndef COSMOS_H // Ensure include guards are present
 #define COSMOS_H
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <math.h>
 #include <string.h>
 // Include other necessary headers like complex.h if used
 
 // --- Constants and Macros (Example) ---
 #define G_CONST 1.0
 #define C_LIGHT 1.0
 // Add other constants/macros if present
 
 // --- Enums (Example if you have them) ---
 typedef enum {
     BOUNDARY_PERIODIC,
     BOUNDARY_REFLECTING,
     BOUNDARY_OUTFLOW
     // Add other boundary types
 } BoundaryType;
 
 
 // --- Fmv0 Class ---
 class Fmv0 {
 public: // Or protected, depending on your design
     // --- Member Variables (Document important public/protected ones) ---
     int tab;
     int jmin;
     int jmax;
     // ... (similarly for kmin, kmax, lmin, lmax)
     double xmin;
     double xmax;
     // ... (similarly for ymin, ymax, zmin, zmax)
     double dx;
     // ... (similarly for dy, dz)
     double cfl;
     double etaa;
     double etab;
     double etabb;
     double KOep;
     double Hb;
     double fluidw;
     double kap_MUSCL;
     double b_minmod;
     int exg;
     double tmax;
     double amp;
 
     // Pointers to grid function arrays (Example for lapse 'alp')
     double ***alp;
     double ***betax;
     // ... (Document ALL BSSN variables: betay, betaz, Gamh1, Gamh2, Gamh3, trK, A11, A12, ...)
     // ... (Document scalar field variables: sf, Pi)
     // ... (Document fluid variables: rho, Sx, Sy, Sz, tau)
     // ... (Document auxiliary variables: Bx, By, Bz)
     // ... (Document boundary flags: bflag)
 
     // --- Constructor & Destructor ---
     Fmv0(int tabs, int jupper, int jlower, int kupper, int klower, int lupper, int llower,
          double xupper, double xlower, double yupper, double ylower, double zupper, double zlower,
          double cfl_in, double etaa_in, double etab_in, double etabb_in, double KOep_in, int exg_in,
          double Hb_in, double fluidw_in, double kap_MUSCL_in, double b_minmod_in, double amp_in);
 
     virtual ~Fmv0(); // Make destructor virtual if inheritance is used
 
     // --- Core Methods ---
     virtual void rhs(double dt, double t); // Make virtual if overridden
 
     void KOdiss(double ***q, double ***f);
 
     double funcf(double x);
     double df(double x);
     double ddf(double x);
     double dddf(double x);
 
     // --- Getters/Setters (Examples) ---
     int get_tab() const;
     double get_cfl() const;
     bool get_fluidevo() const; // Implement logic based on your setup
     int& set_bflag(int l, int k, int j);
     int get_bflag(int l, int k, int j) const;
 
     // --- Utility Functions (Examples) ---
     double*** matrix(long nrl, long nrh, long ncl, long nch, long ndl, long ndh);
     void free_matrix(double ***m, long nrl, long nrh, long ncl, long nch, long ndl, long ndh);
     // Add similar functions for int*** if needed (like for bflag)
 
 protected: // Or private
     // --- Helper functions for RHS (Examples) ---
     double D1x(double ***f, int l, int k, int j); // Add similar for y, z, higher orders
     void calculate_christoffel(int l, int k, int j /*, output parameters */);
     void calculate_ricci(int l, int k, int j /*, output parameters */);
     void calculate_matter_sources(int l, int k, int j /*, output parameters */);
 
     // Add other protected members/methods if necessary
 };
 
 
 // --- Fmv Class ---
 class Fmv : public Fmv0 {
 public:
     Fmv(/* Parameters matching Fmv0 constructor */); // List all params again
 
     virtual ~Fmv();
 
     // --- Overridden/Specific Methods ---
     virtual void set_boundary(); // Override if Fmv0::set_boundary is virtual
 
     void initial_data(double t, double mu, double kk, double xi2, double xi3, double w3);
 
     void initial_nonsph(double t, double mu, double kk, double xi2, double xi3, double w3);
 
     void set_initial_scalar(double mus, double kks, double xi2s, double xi3s);
 
     void set_initial_fluid(double t /*, ... */);
 
     // Add other specific methods for this class
 };
 
 
 // --- Fmv1 Class ---
 class Fmv1 : public Fmv0 {
 public:
     int laymax;
     Fmv0 **fmv; // Or Fmv **fmv;
     int *jbs;
     int *kbs;
     int *lbs;
     double *alp_fmr;
 
     Fmv1(int laymax_in, int *jbs_in, int *kbs_in, int *lbs_in, double *alp_fmr_in /*, base level params */);
 
     virtual ~Fmv1();
 
     void evolution(double dt, double t);
 
     void check_refinement_trigger(double t);
 
     void create_refinement_level(int level);
 
     void prolongate(int coarse_level, int fine_level);
 
     void restrict(int fine_level, int coarse_level);
 
     // Add other FMR-specific methods
 };
 
 
 #endif // COSMOS_H