NavierStokesSolver.h

Go to the documentation of this file.

#pragma once

#include "utilities/types.h"
#include "utilities/domain.h"
#include "utilities/integrationScheme.h"
#include "utilities/parameterDB.h"
#include "utilities/preconditioner.h"
#include "io/io.h"


template <typename memoryType>
class NavierStokesSolver
{
protected:
    parameterDB *paramDB;        
    domain *domInfo;             
    integrationScheme intgSchm;  

    real QCoeff;
    
    cusp::coo_matrix<int, real, memoryType>
        M,     
        Minv,  
        L,     
        A,     
        Q,     
        QT,    
        BN,    
        C;     

    cusp::array1d<real, memoryType>
      q,       
      qStar,   
      qOld,    
      lambda,  
      rn,      
      bc1,     
      bc2,     
      rhs1,    
      rhs2,    
      H,       
      temp1,   
      temp2,   
      bc[4];   
         
    preconditioner< cusp::coo_matrix<int, real, memoryType> >
      *PC1,  
      *PC2;  

    size_t timeStep,         
           subStep,          
           iterationCount1,  
           iterationCount2;  
    
    Logger logger;  
    
    std::ofstream iterationsFile;  
    
    // initialize parameters common to all Navier-Stokes solvers
    void initialiseCommon();
    
    // initialize all arrays required to solve the Navier-Stokes equations
    void initialiseArrays(int numQ, int numLambda);
    
    // initialize velocity flux vectors
    virtual void initialiseFluxes();
    
    // initialize velocity flux vectors
    virtual void initialiseFluxes(real *q);
    
    // initialize boundary velocity arrays with values stored in the database
    void initialiseBoundaryArrays();
    
    // assemble matrices of the intermediate flux solver and the Poisson solver
    void assembleMatrices();

    // generate the mass matrix and its inverse
    void generateM();

    // generate the discrete Laplacian matrix
    virtual void generateL();

    // generate the matrix resulting from the implicit flux terms
    virtual void generateA(real alpha);

    // generate approximate inverse of the matrix resulting from implicit velocity terms
    void generateBN();  

    // generate the discrete divergence matrix
    virtual void generateQT();

    // does nothing
    void updateQ(real gamma);
    
    // generate the matrix of the Poisson solver
    virtual void generateC();

    // generate explicit terms of the momemtum equation
    void generateRN();

    // generate explicit flux terms
    void calculateExplicitQTerms();

    // calculates the explicit lambda terms
    virtual void calculateExplicitLambdaTerms();
    
    // generate inhomogeneous boundary conditions from the discrete Laplacian operator
    virtual void generateBC1();

    // generate inhomogeneous boundary conditions from the discrete continuity equation
    virtual void generateBC2();

    // assemble the right hand-side of the system for the intermediate flux
    virtual void assembleRHS1();

    // assemble the right hand-side of the Poisson system.
    void assembleRHS2();

    // solve for the intermediate flux velocity
    virtual void solveIntermediateVelocity();

    // solve the Poisson system for the pressure (and the body forces if immersed body)
    virtual void solvePoisson();

    // project the flux onto the divergence-free field
    virtual void projectionStep();

    // doing nothing
    void updateBoundaryConditions();

    // doing nothing
    virtual void updateSolverState();

public:
    // constructor -- copy the database and information about the computational grid
    NavierStokesSolver(parameterDB *pDB=NULL, domain *dInfo=NULL);

    // initialize parameters, arrays and matrices required for the simulation
    virtual void initialise();
    
    // calculate the variables at the next time step
    void stepTime();
    
    // write numerical solution and number of iterations performed in each solver.
    virtual void writeCommon();
    
    // write data into files
    virtual void writeData();
    
    // evaluate the condition required to stop the simulation
    bool finished();
    
    // print timing information and clse the different files
    virtual void shutDown();
    
    virtual std::string name()
    {
        return "Navier-Stokes";
    }
};