expression.hpp

// FEAT3: Finite Element Analysis Toolbox, Version 3
// Copyright (C) 2010 by Stefan Turek & the FEAT group
// FEAT3 is released under the GNU General Public License version 3,
// see the file 'copyright.txt' in the top level directory for details.
 
#pragma once
 
// includes, FEAT
#include <kernel/base_header.hpp>
#include <kernel/util/exception.hpp>
#include <kernel/util/string.hpp>
 
namespace FEAT
{
  namespace Solver
  {
    // forward declaration
    enum class Status;
 
    enum class ExpressionType
    {
      start_solve = 0,
      end_solve,
      call_precond,
      call_precond_l,
      call_precond_r,
      call_smoother,
      call_coarse_solver,
      defect,
      timings,
      level_timings,
      prol,
      rest,
      call_uzawa_s,
      call_uzawa_a
    };
 
    inline std::ostream& operator<<(std::ostream& os, ExpressionType type)
    {
      switch(type)
      {
        case ExpressionType::start_solve:
        return os << "start";
        case ExpressionType::end_solve:
        return os << "end";
        case ExpressionType::call_precond:
        return os << "precond";
        case ExpressionType::call_precond_l:
        return os << "precond_l";
        case ExpressionType::call_precond_r:
        return os << "precond_r";
        case ExpressionType::call_smoother:
        return os << "smoother";
        case ExpressionType::call_coarse_solver:
        return os << "coarse";
        case ExpressionType::defect:
        return os << "defect";
        case ExpressionType::timings:
        return os << "timings";
        case ExpressionType::level_timings:
        return os << "level_timings";
        case ExpressionType::prol:
        return os << "prol";
        case ExpressionType::rest:
        return os << "rest";
        case ExpressionType::call_uzawa_s:
        return os << "uzawa_s";
        case ExpressionType::call_uzawa_a:
        return os << "uzawa_a";
      default:
        return os << "unknown";
      }
    }
 
    class ExpressionBase
    {
      public:
        String solver_name;
 
        explicit ExpressionBase(String name) :
          solver_name(name)
        {
        }
 
        virtual ~ExpressionBase()
        {
        }
 
        virtual ExpressionType get_type() = 0;
    };
 
    class ExpressionStartSolve : public ExpressionBase
    {
      public:
        explicit ExpressionStartSolve(String name) :
          ExpressionBase(name)
        {
        }
 
        virtual ~ExpressionStartSolve()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::start_solve;
        }
    };
 
    class ExpressionEndSolve : public ExpressionBase
    {
      public:
        Status status;
        Index iters;
 
        explicit ExpressionEndSolve(String name, Status end_status, Index iterations) :
          ExpressionBase(name),
          status(end_status),
          iters(iterations)
        {
        }
        virtual ~ExpressionEndSolve()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::end_solve;
        }
    };
 
    class ExpressionCallPrecond : public ExpressionBase
    {
      public:
        String precond_name;
 
        explicit ExpressionCallPrecond(String name, String precond_name_in) :
          ExpressionBase(name),
          precond_name(precond_name_in)
        {
        }
 
        virtual ~ExpressionCallPrecond()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_precond;
        }
    };
 
    class ExpressionCallPrecondL : public ExpressionBase
    {
      public:
        String precond_name;
 
        explicit ExpressionCallPrecondL(String name, String precond_name_in) :
          ExpressionBase(name),
          precond_name(precond_name_in)
        {
        }
 
        virtual ~ExpressionCallPrecondL()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_precond_l;
        }
    };
 
    class ExpressionCallPrecondR : public ExpressionBase
    {
      public:
        String precond_name;
 
        explicit ExpressionCallPrecondR(String name, String precond_name_in) :
          ExpressionBase(name),
          precond_name(precond_name_in)
        {
        }
 
        virtual ~ExpressionCallPrecondR()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_precond_r;
        }
    };
 
    class ExpressionCallSmoother : public ExpressionBase
    {
      public:
        String smoother_name;
 
        explicit ExpressionCallSmoother(String name, String smoother_name_in) :
          ExpressionBase(name),
          smoother_name(smoother_name_in)
        {
        }
 
        virtual ~ExpressionCallSmoother()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_smoother;
        }
    };
 
    class ExpressionCallCoarseSolver : public ExpressionBase
    {
      public:
        String coarse_solver_name;
 
        explicit ExpressionCallCoarseSolver(String name, String coarse_solver_name_in) :
          ExpressionBase(name),
          coarse_solver_name(coarse_solver_name_in)
        {
        }
 
        virtual ~ExpressionCallCoarseSolver()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_coarse_solver;
        }
    };
 
    class ExpressionProlongation : public ExpressionBase
    {
      public:
        Index level;
 
        explicit ExpressionProlongation(String name, Index level_in) :
          ExpressionBase(name),
          level(level_in)
        {
        }
 
        virtual ~ExpressionProlongation()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::prol;
        }
    };
 
    class ExpressionRestriction : public ExpressionBase
    {
      public:
        Index level;
 
        explicit ExpressionRestriction(String name, Index level_in) :
          ExpressionBase(name),
          level(level_in)
        {
        }
 
        virtual ~ExpressionRestriction()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::rest;
        }
    };
 
    class ExpressionDefect : public ExpressionBase
    {
      public:
        double def;
        Index iter;
 
        explicit ExpressionDefect(String name, double defect, Index iter_in) :
          ExpressionBase(name),
          def(defect),
          iter(iter_in)
        {
        }
 
        virtual ~ExpressionDefect()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::defect;
        }
    };
 
    class ExpressionTimings : public ExpressionBase
    {
      public:
        double solver_toe, mpi_execute_reduction, mpi_execute_blas2, mpi_execute_blas3, mpi_execute_collective, mpi_wait_reduction, mpi_wait_blas2, mpi_wait_blas3, mpi_wait_collective;
 
        explicit ExpressionTimings(String name, double solver_toe_in, double mpi_execute_reduction_in, double mpi_execute_blas2_in, double mpi_execute_blas3_in,
            double mpi_execute_collective_in, double mpi_wait_reduction_in, double mpi_wait_blas2_in, double mpi_wait_blas3_in, double mpi_wait_collective_in) :
          ExpressionBase(name),
          solver_toe(solver_toe_in),
          mpi_execute_reduction(mpi_execute_reduction_in),
          mpi_execute_blas2(mpi_execute_blas2_in),
          mpi_execute_blas3(mpi_execute_blas3_in),
          mpi_execute_collective(mpi_execute_collective_in),
          mpi_wait_reduction(mpi_wait_reduction_in),
          mpi_wait_blas2(mpi_wait_blas2_in),
          mpi_wait_blas3(mpi_wait_blas3_in),
          mpi_wait_collective(mpi_wait_collective_in)
        {
        }
 
        virtual ~ExpressionTimings()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::timings;
        }
    };
 
    class ExpressionLevelTimings : public ExpressionBase
    {
      public:
        Index level;
        double level_toe, mpi_execute_reduction, mpi_execute_blas2, mpi_execute_blas3, mpi_execute_collective, mpi_wait_reduction, mpi_wait_blas2, mpi_wait_blas3, mpi_wait_collective;
 
        explicit ExpressionLevelTimings(String name, Index level_in, double level_toe_in, double mpi_execute_reduction_in, double mpi_execute_blas2_in, double mpi_execute_blas3_in,
            double mpi_execute_collective_in, double mpi_wait_reduction_in, double mpi_wait_blas2_in, double mpi_wait_blas3_in, double mpi_wait_collective_in) :
          ExpressionBase(name),
          level(level_in),
          level_toe(level_toe_in),
          mpi_execute_reduction(mpi_execute_reduction_in),
          mpi_execute_blas2(mpi_execute_blas2_in),
          mpi_execute_blas3(mpi_execute_blas3_in),
          mpi_execute_collective(mpi_execute_collective_in),
          mpi_wait_reduction(mpi_wait_reduction_in),
          mpi_wait_blas2(mpi_wait_blas2_in),
          mpi_wait_blas3(mpi_wait_blas3_in),
          mpi_wait_collective(mpi_wait_collective_in)
        {
        }
 
        virtual ~ExpressionLevelTimings()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::level_timings;
        }
    };
 
    class ExpressionCallUzawaS : public ExpressionBase
    {
      public:
        String solver_s_name;
 
        explicit ExpressionCallUzawaS(String name, String solver_s_name_in) :
          ExpressionBase(name),
          solver_s_name(solver_s_name_in)
        {
        }
 
        virtual ~ExpressionCallUzawaS()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_uzawa_s;
        }
    };
 
    class ExpressionCallUzawaA : public ExpressionBase
    {
      public:
        String solver_a_name;
 
        explicit ExpressionCallUzawaA(String name, String solver_a_name_in) :
          ExpressionBase(name),
          solver_a_name(solver_a_name_in)
        {
        }
 
        virtual ~ExpressionCallUzawaA()
        {
        }
 
        virtual ExpressionType get_type() override
        {
          return ExpressionType::call_uzawa_a;
        }
    };
  } // namespace Solver
} // namespace FEAT