euler_vortex.cpp

#include <stdlib.h>     /* srand, rand */
#include <iostream>

#include <deal.II/base/convergence_table.h>

#include <deal.II/dofs/dof_tools.h>

#include <deal.II/grid/grid_generator.h>
#include <deal.II/grid/grid_refinement.h>
#include <deal.II/grid/grid_tools.h>
#include <deal.II/grid/grid_out.h>
#include <deal.II/grid/grid_in.h>

#include <deal.II/numerics/vector_tools.h>

#include <deal.II/lac/affine_constraints.h>


#include <deal.II/fe/fe_values.h>

#include <Sacado.hpp>

#include <deal.II/fe/mapping_q.h>

#include "tests.h"
#include "euler_vortex.h"

#include "physics/physics_factory.h"
#include "physics/manufactured_solution.h"
#include "dg/dg_factory.hpp"
#include "ode_solver/ode_solver_factory.h"


namespace PHiLiP {
namespace Tests {

template <int dim, int nspecies, typename real>
EulerVortexFunction<dim,nspecies,real>
::EulerVortexFunction (
        const Physics::Euler<dim, nspecies, dim+2, real> euler_physics,
        const dealii::Point<dim> initial_vortex_center,
        const real vortex_strength,
        const real vortex_stddev_decay)
    :
    dealii::Function<dim,real>(dim+2, 0.0)
    , euler_physics(euler_physics)
    , vortex_characteristic_length(1.0*euler_physics.ref_length)
    , initial_vortex_center(initial_vortex_center)
    , vortex_strength(vortex_strength)
    , vortex_stddev_decay(vortex_stddev_decay)
{ 
    static_assert(dim==2);
}

template <int dim, int nspecies, typename real>
inline dealii::Point<dim> EulerVortexFunction<dim,nspecies,real>::advected_location(dealii::Point<dim> grid_location) const
{
    dealii::Point<dim> new_location;
    const double time = this->get_time();
    for(int d=0; d<dim; d++) {
        new_location[d] = (grid_location[d] - initial_vortex_center[d]) - euler_physics.velocities_inf[d] * time;
    }
    return new_location;
}

template <int dim, int nspecies, typename real>
inline real EulerVortexFunction<dim,nspecies,real>
::value (const dealii::Point<dim> &point, const unsigned int istate) const
{
    const double variance = vortex_stddev_decay*vortex_stddev_decay;

    dealii::Point<dim> new_loc = advected_location(point);
    const double x = new_loc[0];
    const double y = new_loc[1];

    //const double local_radius_sqr = new_loc.square();
    //const double pi = dealii::numbers::PI;
    //const double perturbation_strength = vortex_strength * exp(0.5*variance*(1.0-local_radius_sqr)) * 0.5 / pi;
    //const double delta_vel_x = -y * perturbation_strength;
    //const double delta_vel_y =  x * perturbation_strength;
    //const double delta_temp  =  euler_physics.temperature_inf / pow(euler_physics.sound_inf, 2) * 0.5*euler_physics.gamm1 * perturbation_strength*perturbation_strength;

    //const double vel_x = euler_physics.velocities_inf[0] + delta_vel_x;
    //const double vel_y = euler_physics.velocities_inf[1] + delta_vel_y;
    //const double temperature = (euler_physics.temperature_inf + delta_temp);

    //const double density = euler_physics.density_inf*pow(temperature/euler_physics.temperature_inf, 1.0/euler_physics.gamm1);
    //const double pressure = euler_physics.pressure_inf * pow(temperature/euler_physics.temperature_inf, euler_physics.gam/euler_physics.gamm1);

    // Spiegel2015 isentropic vortex
    //const double local_radius_sqr = new_loc.square();
    //const double perturbation_strength = vortex_strength * exp(-0.5/(variance*std::pow(vortex_characteristic_length,2))*(local_radius_sqr));
    //const double delta_vel_x = -y * perturbation_strength;
    //const double delta_vel_y =  x * perturbation_strength;
    //const double delta_temp  =  -0.5*euler_physics.gamm1 * perturbation_strength*perturbation_strength;

    //const double vel_x = euler_physics.velocities_inf[0] + delta_vel_x;
    //const double vel_y = euler_physics.velocities_inf[1] + delta_vel_y;
    //const double temperature = euler_physics.temperature_inf * (1.0+delta_temp);
    //const double pressure = euler_physics.pressure_inf * std::pow(1.0+delta_temp,euler_physics.gam/euler_physics.gamm1);
    //const double density = euler_physics.compute_density_from_pressure_temperature (pressure, temperature);


    // Philip's isentropic vortex
    const double r2 = (std::pow(x,2.0)+std::pow(y,2.0))/(variance);
    const double density  = euler_physics.density_inf;
    const double vel_x    = euler_physics.velocities_inf[0] - y*vortex_strength/(variance)*exp(-0.5*r2);
    const double vel_y    = euler_physics.velocities_inf[1] + x*vortex_strength/(variance)*exp(-0.5*r2);
    const double pressure = euler_physics.pressure_inf  - euler_physics.density_inf*(vortex_strength*vortex_strength)/(2*variance)*exp(-r2);

    const std::array<double, 4> primitive_values = {{density, vel_x, vel_y, pressure}};
    const std::array<double, 4> conservative_values = euler_physics.convert_primitive_to_conservative(primitive_values);

    //std::cout << density << " " << pressure << std::endl;
    //std::cout << primitive_values[0] << " " << primitive_values[1] << " " << primitive_values[2]<< " " << primitive_values[3]<< std::endl;
    //std::cout << conservative_values[0] << " " << conservative_values[1] << " " << conservative_values[2]<< " " << conservative_values[3]<< std::endl;
    // if(std::abs(x) > 19.9) {
    //     std::cout<< "density " << conservative_values[0] << std::endl;
    //     std::cout<< "momx " << conservative_values[1] << std::endl;
    //     std::cout<< "momy " << conservative_values[2] << std::endl;
    //     std::cout<< "energy " << conservative_values[3] << std::endl;
    //     std::cout<< std::endl;
    // }

    return conservative_values[istate];
}

template <int dim, int nspecies, int nstate>
EulerVortex<dim,nspecies,nstate>::EulerVortex(const Parameters::AllParameters *const parameters_input)
    :
    TestsBase::TestsBase(parameters_input)
{}

template<int dim, int nspecies, int nstate>
int EulerVortex<dim,nspecies,nstate>
::run_test () const
{
    using ManParam = Parameters::ManufacturedConvergenceStudyParam;
    using GridEnum = ManParam::GridEnum;
    const Parameters::AllParameters param = *(TestsBase::all_parameters);

    Assert(dim == param.dimension, dealii::ExcDimensionMismatch(dim, param.dimension));
    Assert(dim == 2, dealii::ExcDimensionMismatch(dim, 2));

    ManParam manu_grid_conv_param = param.manufactured_convergence_study_param;

    const unsigned int p_start             = manu_grid_conv_param.degree_start;
    const unsigned int p_end               = manu_grid_conv_param.degree_end;

    const unsigned int n_grids_input       = manu_grid_conv_param.number_of_grids;

    std::vector<int> fail_conv_poly;
    std::vector<double> fail_conv_slop;
    std::vector<dealii::ConvergenceTable> convergence_table_vector;

    std::shared_ptr <Physics::PhysicsBase<dim,nspecies,nstate,double>> physics = Physics::PhysicsFactory<dim, nspecies, nstate, double>::create_Physics(&param);
    std::shared_ptr <Physics::Euler<dim,nspecies,nstate,double>> euler = std::dynamic_pointer_cast<Physics::Euler<dim,nspecies,nstate,double>>(physics);

    const dealii::Point<dim> initial_vortex_center(-0.0,-0.0);
    const double vortex_strength = euler->mach_inf*4.0;
    const double vortex_stddev_decay = 1.0;
    const double half_length = 5*euler->ref_length;
    //const double half_length = 5*euler->ref_length;
    EulerVortexFunction<dim,nspecies,double> initial_vortex_function(*euler, initial_vortex_center, vortex_strength, vortex_stddev_decay);
    initial_vortex_function.set_time(0.0);

    for (unsigned int poly_degree = p_start; poly_degree <= p_end; ++poly_degree) {

        // p0 tends to require a finer grid to reach asymptotic region
        unsigned int n_grids = n_grids_input;
        //if (poly_degree <= 2) n_grids = n_grids_input + 1;

        std::vector<double> soln_error(n_grids);
        std::vector<double> grid_size(n_grids);

        const std::vector<int> n_1d_cells = get_number_1d_cells(n_grids);

        dealii::ConvergenceTable convergence_table;

        for (unsigned int igrid=0; igrid<n_grids; ++igrid) {
            // Note that Triangulation must be declared before DG
            // DG will be destructed before Triangulation
            // thus removing any dependence of Triangulation and allowing Triangulation to be destructed
            // Otherwise, a Subscriptor error will occur
            using Triangulation = dealii::parallel::distributed::Triangulation<dim>;
            std::shared_ptr <Triangulation> grid = std::make_shared<Triangulation> (this->mpi_communicator,
                typename dealii::Triangulation<dim>::MeshSmoothing(
                    dealii::Triangulation<dim>::smoothing_on_refinement |
                    dealii::Triangulation<dim>::smoothing_on_coarsening));

            // Generate hypercube
            if ( manu_grid_conv_param.grid_type == GridEnum::hypercube || manu_grid_conv_param.grid_type == GridEnum::sinehypercube ) {

                std::vector<unsigned int> n_subdivisions(2);
                n_subdivisions[0] = n_1d_cells[igrid];
                n_subdivisions[1] = n_1d_cells[igrid];
                const bool colorize = true;
                dealii::Point<dim> p1(-half_length,-half_length), p2(half_length,half_length);
                dealii::GridGenerator::subdivided_hyper_rectangle (*grid, n_subdivisions, p1, p2, colorize);
                for (typename Triangulation::active_cell_iterator cell = grid->begin_active(); cell != grid->end(); ++cell) {
                    // Set a dummy boundary ID
                    for (unsigned int face=0; face<dealii::GeometryInfo<dim>::faces_per_cell; ++face) {
                        if (cell->face(face)->at_boundary()) {
                            unsigned int current_id = cell->face(face)->boundary_id();
                            if (current_id == 0) {
                                cell->face(face)->set_boundary_id (1004); // x_left, Farfield
                            } else if (current_id == 1) {
                                cell->face(face)->set_boundary_id (1004); // x_right, Symmetry/Wall
                            } else if (current_id == 2) {
                                cell->face(face)->set_boundary_id (1004); // y_bottom, Symmetry/Wall
                            } else if (current_id == 3) {
                                cell->face(face)->set_boundary_id (1004); // y_top, Wall
                            } else {
                                std::cout << "current_face_id " << current_id << std::endl;
                                std::abort();
                            }
                        }
                    }
                }
            //const double max_ratio = 1.5;
            }

            // Distort grid by random amount if requested
            const double random_factor = manu_grid_conv_param.random_distortion;
            const bool keep_boundary = true;
            if (random_factor > 0.0) dealii::GridTools::distort_random (random_factor, *grid, keep_boundary);

            // Create DG object using the factory
            std::shared_ptr < DGBase<dim, nspecies, double> > dg = DGFactory<dim,nspecies,double>::create_discontinuous_galerkin(&param, poly_degree, grid);
            dg->allocate_system ();

            // Initialize solution with vortex function at time t=0
            dealii::VectorTools::interpolate(dg->dof_handler, initial_vortex_function, dg->solution);
            // dealii::AffineConstraints<double> constraints;
            // constraints.close();
            // dealii::VectorTools::project (dg->dof_handler,
            //                         constraints,
            //                         dg->volume_quadrature_collection,
            //                         initial_vortex_function,
            //                         dg->solution);

            // Create ODE solver using the factory and providing the DG object
            std::shared_ptr<ODE::ODESolverBase<dim, nspecies, double>> ode_solver = ODE::ODESolverFactory<dim, nspecies, double>::create_ODESolver(dg);

            const unsigned int n_active_cells = grid->n_active_cells();
            const unsigned int n_dofs = dg->dof_handler.n_dofs();
            std::cout
                      << "Dimension: " << dim << "\t Polynomial degree p: " << poly_degree << std::endl
                      << "Grid number: " << igrid+1 << "/" << n_grids
                      << ". Number of active cells: " << n_active_cells
                      << ". Number of degrees of freedom: " << n_dofs
                      << std::endl;

            // Not really steady state
            // Will have a low number of time steps in the control file (around 10-20)
            // We can then compare the exact solution to whatever time it reached
            ode_solver->steady_state();
            
            EulerVortexFunction<dim,nspecies,double> final_vortex_function(*euler, initial_vortex_center, vortex_strength, vortex_stddev_decay);
            const double final_time = ode_solver->current_time;
            final_vortex_function.set_time(final_time);

            // Overintegrate the error to make sure there is not integration error in the error estimate
            int overintegrate = 10;
            dealii::QGauss<dim> quad_extra(dg->max_degree+1+overintegrate);
            dealii::MappingQ<dim,dim> mappingq(dg->max_degree+overintegrate);
            dealii::FEValues<dim,dim> fe_values_extra(mappingq, dg->fe_collection[poly_degree], quad_extra, 
                    dealii::update_values | dealii::update_JxW_values | dealii::update_quadrature_points);
            const unsigned int n_quad_pts = fe_values_extra.n_quadrature_points;
            std::array<double,nstate> soln_at_q;

            double l2error = 0;

            std::vector<dealii::types::global_dof_index> dofs_indices (fe_values_extra.dofs_per_cell);
            // Integrate solution error
            for (auto cell = dg->dof_handler.begin_active(); cell!=dg->dof_handler.end(); ++cell) {

                fe_values_extra.reinit (cell);
                cell->get_dof_indices (dofs_indices);

                for (unsigned int iquad=0; iquad<n_quad_pts; ++iquad) {

                    std::fill(soln_at_q.begin(), soln_at_q.end(), 0);
                    for (unsigned int idof=0; idof<fe_values_extra.dofs_per_cell; ++idof) {
                        const unsigned int istate = fe_values_extra.get_fe().system_to_component_index(idof).first;
                        soln_at_q[istate] += dg->solution[dofs_indices[idof]] * fe_values_extra.shape_value_component(idof, iquad, istate);
                    }

                    const dealii::Point<dim> qpoint = (fe_values_extra.quadrature_point(iquad));

                    // Check only density
                    // Check only energy
                    for (int istate=3; istate<4; ++istate) {
                        const double uexact = final_vortex_function.value(qpoint, istate);
                        l2error += pow(soln_at_q[istate] - uexact, 2) * fe_values_extra.JxW(iquad);
                    }
                }

            }
            l2error = sqrt(l2error);

            // Convergence table
            double dx = 1.0/pow(n_dofs,(1.0/dim));
            //dx = dealii::GridTools::maximal_cell_diameter(*grid);
            grid_size[igrid] = dx;
            soln_error[igrid] = l2error;

            convergence_table.add_value("p", poly_degree);
            convergence_table.add_value("cells", n_active_cells);
            convergence_table.add_value("DoFs", n_dofs);
            convergence_table.add_value("dx", dx);
            convergence_table.add_value("soln_L2_error", l2error);


            std::cout   << " Grid size h: " << dx 
                        << " L2-soln_error: " << l2error
                        << " Residual: " << ode_solver->residual_norm
                        << std::endl;

            if (igrid > 0) {
                const double slope_soln_err = log(soln_error[igrid]/soln_error[igrid-1])
                                      / log(grid_size[igrid]/grid_size[igrid-1]);
                std::cout << "From grid " << igrid-1
                          << "  to grid " << igrid
                          << "  dimension: " << dim
                          << "  polynomial degree p: " << poly_degree
                          << std::endl
                          << "  solution_error1 " << soln_error[igrid-1]
                          << "  solution_error2 " << soln_error[igrid]
                          << "  slope " << slope_soln_err
                          << std::endl;
            }
        }
        std::cout
            << " ********************************************"
            << std::endl
            << " Convergence rates for p = " << poly_degree
            << std::endl
            << " ********************************************"
            << std::endl;
        convergence_table.evaluate_convergence_rates("soln_L2_error", "cells", dealii::ConvergenceTable::reduction_rate_log2, dim);
        convergence_table.set_scientific("dx", true);
        convergence_table.set_scientific("soln_L2_error", true);
        convergence_table.write_text(std::cout);

        convergence_table_vector.push_back(convergence_table);

        const double expected_slope = poly_degree+1;

        const double last_slope = log(soln_error[n_grids-1]/soln_error[n_grids-2])
                                  / log(grid_size[n_grids-1]/grid_size[n_grids-2]);
        double before_last_slope = last_slope;
        if ( n_grids > 2 ) {
        before_last_slope = log(soln_error[n_grids-2]/soln_error[n_grids-3])
                            / log(grid_size[n_grids-2]/grid_size[n_grids-3]);
        }
        // Don't actually take the average for this case
        const double slope_avg = 0.5*before_last_slope+ 0.5*last_slope;
        const double slope_diff = slope_avg-expected_slope;

        double slope_deficit_tolerance = -std::abs(manu_grid_conv_param.slope_deficit_tolerance);
        if(poly_degree == 0) slope_deficit_tolerance *= 2; // Otherwise, grid sizes need to be much bigger for p=0

        if (slope_diff < slope_deficit_tolerance) {
            std::cout << std::endl
                      << "Convergence order not achieved. Average last 2 slopes of "
                      << slope_avg << " instead of expected "
                      << expected_slope << " within a tolerance of "
                      << slope_deficit_tolerance
                      << std::endl;
            // p=0 just requires too many meshes to get into the asymptotic region.
            if(poly_degree!=0) fail_conv_poly.push_back(poly_degree);
            if(poly_degree!=0) fail_conv_slop.push_back(slope_avg);
        }

    }
    std::cout << std::endl
              << std::endl
              << std::endl
              << std::endl;
    std::cout << " ********************************************"
              << std::endl;
    std::cout << " Convergence summary"
              << std::endl;
    std::cout << " ********************************************"
              << std::endl;
    for (auto conv = convergence_table_vector.begin(); conv!=convergence_table_vector.end(); conv++) {
        conv->write_text(std::cout);
        std::cout << " ********************************************"
                  << std::endl;
    }
    int n_fail_poly = fail_conv_poly.size();
    if (n_fail_poly > 0) {
        for (int ifail=0; ifail < n_fail_poly; ++ifail) {
            const double expected_slope = fail_conv_poly[ifail]+1;
            const double slope_deficit_tolerance = -0.1;
            std::cout << std::endl
                      << "Convergence order not achieved for polynomial p = "
                      << fail_conv_poly[ifail]
                      << ". Slope of "
                      << fail_conv_slop[ifail] << " instead of expected "
                      << expected_slope << " within a tolerance of "
                      << slope_deficit_tolerance
                      << std::endl;
        }
    }
    return n_fail_poly;
}

#if PHILIP_DIM==2 && PHILIP_SPECIES==1
    template class EulerVortex <PHILIP_DIM, PHILIP_SPECIES,PHILIP_DIM+2>;
#endif


} // Tests namespace
} // PHiLiP namespace