claw_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

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

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef CLAW_SYSTEM_H
#define CLAW_SYSTEM_H

// libMesh includes
#include "libmesh/linear_implicit_system.h" // base class

namespace libMesh
{

class ClawSystem : public LinearImplicitSystem
{
public:

  enum TemporalDiscretizationType {ForwardEuler = 0, RK4};

  ClawSystem (EquationSystems & es,
              const std::string & name,
              const unsigned int number);

  virtual ~ClawSystem ();

  typedef LinearImplicitSystem Parent;

  virtual std::string system_type () const override;

  static TemporalDiscretizationType string_to_enum(std::string string_type);
  static std::string enum_to_string(TemporalDiscretizationType enum_type);

  virtual void process_parameters_file (const std::string& parameters_filename);

  void solve_conservation_law();

  virtual void assemble_claw_rhs(NumericVector<Number> &) = 0;

  void assemble_all_matrices();

  SparseMatrix<Number> & get_mass_matrix();
  SparseMatrix<Number> & get_advection_matrix(unsigned int dim);
  SparseMatrix<Number> & get_avg_matrix(unsigned int dim);
  SparseMatrix<Number> & get_jump_matrix();
  SparseMatrix<Number> & get_boundary_condition_matrix(unsigned int dim);

  void set_delta_t(Real delta_t_in);
  Real get_delta_t();

  void set_n_time_steps(unsigned int n_time_steps_in);
  unsigned int get_n_time_steps();

  void set_LxF_constant(Real LxF_constant_in);
  Real get_LxF_constant();

  void set_temporal_discretization_type(TemporalDiscretizationType td_in);
  TemporalDiscretizationType get_temporal_discretization_type();

  void set_write_interval(unsigned int write_interval_in);
  unsigned int get_write_interval();

  void set_time(Real time_in);
  Real get_time();

  virtual void print_info();

  void write_out_discretization_matrices();

  virtual void init_data() override;

private:

  void assemble_mass_matrix();
  void assemble_advection_matrices();
  void assemble_avg_coupling_matrices();
  void assemble_jump_coupling_matrix();
  void assemble_boundary_condition_matrices();

  std::unique_ptr<SparseMatrix<Number>> _mass_matrix;

  std::vector<std::unique_ptr<SparseMatrix<Number>>> _advection_matrices;

  std::vector<std::unique_ptr<SparseMatrix<Number>>> _avg_matrices;

  std::unique_ptr<SparseMatrix<Number>> _jump_matrix;

  std::vector<std::unique_ptr<SparseMatrix<Number>>> _boundary_condition_matrices;

  TemporalDiscretizationType _temporal_discretization_type;

  Real _delta_t;

  unsigned int _n_time_steps;

  Real _LxF_constant;

  unsigned int _write_interval;

  Real _time;
};

} // namespace libMesh

#endif