driver.h

/*  ______________________________________________________________________
 *
 *  ExaDG - High-Order Discontinuous Galerkin for the Exa-Scale
 *
 *  Copyright (C) 2022 by the ExaDG authors
 *
 *  This program 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.
 *
 *  This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 *  ______________________________________________________________________
 */
 
#ifndef INCLUDE_EXADG_FLUID_STRUCTURE_INTERACTION_PRECICE_DRIVER_H_
#define INCLUDE_EXADG_FLUID_STRUCTURE_INTERACTION_PRECICE_DRIVER_H_
 
#include <deal.II/lac/la_parallel_vector.h>
 
#include <exadg/fluid_structure_interaction/precice/precice_adapter.h>
#include <exadg/fluid_structure_interaction/precice/precice_parameters.h>
#include <exadg/fluid_structure_interaction/single_field_solvers/fluid.h>
#include <exadg/fluid_structure_interaction/single_field_solvers/structure.h>
#include <exadg/fluid_structure_interaction/user_interface/application_base.h>
#include <exadg/utilities/print_general_infos.h>
 
namespace ExaDG
{
namespace FSI
{
namespace preCICE
{
template<int dim, typename Number>
class Driver
{
private:
  using VectorType = dealii::LinearAlgebra::distributed::Vector<Number>;
 
public:
  Driver(std::string const &                           input_file,
         MPI_Comm const &                              comm,
         std::shared_ptr<ApplicationBase<dim, Number>> app,
         bool const                                    is_test)
    : mpi_comm(comm),
      pcout(std::cout, dealii::Utilities::MPI::this_mpi_process(comm) == 0),
      application(app),
      precice_parameters(ExaDG::preCICE::ConfigurationParameters(input_file)),
      is_test(is_test)
  {
    print_general_info<Number>(pcout, mpi_comm, is_test);
  }
 
  virtual void
  setup() = 0;
 
  virtual void
  solve() const = 0;
 
  virtual void
  print_performance_results(double const total_time) const = 0;
 
  virtual ~Driver() = default;
 
protected:
  // MPI communicator
  MPI_Comm const mpi_comm;
 
  // output to std::cout
  dealii::ConditionalOStream pcout;
 
  // application
  std::shared_ptr<ApplicationBase<dim, Number>>                  application;
  std::shared_ptr<ExaDG::preCICE::Adapter<dim, dim, VectorType>> precice;
  ExaDG::preCICE::ConfigurationParameters                        precice_parameters;
 
  // do not print wall times if is_test
  bool const is_test;
 
  /*
   * Computation time (wall clock time).
   */
  mutable TimerTree timer_tree;
};
 
} // namespace preCICE
} // namespace FSI
} // namespace ExaDG
 
 
#endif /* INCLUDE_EXADG_FLUID_STRUCTURE_INTERACTION_PRECICE_DRIVER_H_ */