snoopy.h

Go to the documentation of this file.

/*      
        This file is part of the Snoopy code.

    Snoopy code is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Snoopy code is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Snoopy code.  If not, see <http://www.gnu.org/licenses/>.
*/



#ifndef __SNOOPY_H__
#define __SNOOPY_H__

#include <math.h>
#include <complex.h>
#include <fftw3.h>

#ifdef MPI_SUPPORT
#include <mpi.h>
#ifdef FFTW3_MPI_SUPPORT
#include <fftw3-mpi.h>
#endif
#endif

#ifdef _OPENMP
#include <omp.h>
#endif

#include "gvars.h"

#ifdef WITH_2D
#undef NZ
#define NZ              1               // enforce NZ when in 2D
#endif

#include "error.h"

// Enforce No elssaser when not using MHD
#ifdef ELSASSER_FORMULATION
#ifndef MHD
#undef ELSASSER_FORMULATION
#endif
#endif

#ifdef MPI_SUPPORT
#define         MPI_Printf                      if (rank==0) printf
#else
#define         MPI_Printf                      printf
#endif


// fix NPROC if MPI_SUPPORT is disabled
#ifndef MPI_SUPPORT
#ifndef         NPROC
#define         NPROC                   1
#endif
#endif

#define         NTOTAL                  NX * NY * NZ    
#ifdef WITH_2D
#define         NX_COMPLEX              NX                              
#define         NY_COMPLEX              (NY / 2 + 1)    
#define         NZ_COMPLEX              1                               
#else
#define         NX_COMPLEX              NX                              
#define         NY_COMPLEX              NY                              
#define         NZ_COMPLEX              (NZ / 2 + 1)    
#endif

#define         NTOTAL_COMPLEX  (NX_COMPLEX * NY_COMPLEX * NZ_COMPLEX / NPROC)  
#define         IDX3D                   (k + j * NZ_COMPLEX + NZ_COMPLEX * NY_COMPLEX * i)  
// Filenames

#define OUTPUT_DUMP                                     "dump.dmp"                      
#define OUTPUT_DUMP_SAV                         "dump_sav.dmp"      
#define OUTPUT_DUMP_WRITE                       "dump_write.dmp"        
// Structures

#ifdef WITH_PARTICLES
struct Particle {
        double x;
        double y;
        double z;
        double vx;
        double vy;
        double vz;
        double mass;    // unused for the moment
        double stime;   // Stopping time
};
#endif

struct Field {
        int        nfield;
        double complex **farray;
        char   **fname;
        
         // This are the actual fields. 
        double complex *vx;
        double complex *vy;
        double complex *vz;
#ifdef BOUSSINESQ
        double complex *th;
#endif
#ifdef MHD
        double complex *bx;
        double complex *by;
        double complex *bz;
#endif
#ifdef COMPRESSIBLE
        double complex *d;
#endif
#ifdef WITH_PARTICLES
        struct Particle *part;
#endif
};

struct VarName {
        int             length;         // Number of varnames
        char**  name;           // Varnames (need to be allocated properly)
};

struct Parameters {
        // Physics Parameters
        double lx;                              
        double ly;                              
        double lz;                              
        double reynolds;                
        double reynolds_m;              
        double reynolds_th;             
        double reynolds_B;              
        double x_hall;                  
        double N2;                              
        double omega;                   
        double shear;                   
        double omega_shear;             
        double cs;                              
        // Particles parameters
        int    particles_n;             
        double particles_mass;  
        double particles_stime; 
        double particles_dg_ratio;      
        double particles_epsilon;       
        // Code parameters
        
        double cfl;                             
        double safety_source;   
        double t_initial;               
        double t_final;                 
        double max_t_elapsed;   
        int    interface_check; 
        int    interface_output_file;   
        int    force_symmetries;        
        int    symmetries_step;         
        int    antialiasing;            
        int    restart;
        
        // Output parameters
        double toutput_time;            
        double toutput_flow;            
        double toutput_dump;            
        int             output_vorticity;       
        struct VarName timevar_vars;    
        // initial conditions
        int        init_vortex;                 
        double vortex_a;                        
        double vortex_b;                        
        int    init_spatial_structure;  
        int        init_large_scale_noise;      
        double per_amplitude_large;             
        double noise_cut_length;                
        int        init_large_scale_2D_noise;   
        double per_amplitude_large_2D;          
        double noise_cut_length_2D;                 
        int    init_white_noise;                
        double per_amplitude_noise;             
        int    init_mean_field;                 
        double bx0;                                             
        double by0;                                             
        double bz0;                                             
        int    init_dump;                               
        int        init_bench;                          
};

#endif