[P]arallel [Hi]gh-order [Li]brary for [P]DEs  Latest
Parallel High-Order Library for PDEs through hp-adaptive Discontinuous Galerkin methods
model.h
1 #ifndef __MODEL__
2 #define __MODEL__
3 
4 #include <deal.II/base/conditional_ostream.h>
5 #include <deal.II/base/types.h>
6 #include <deal.II/base/tensor.h>
7 #include <deal.II/lac/la_parallel_vector.templates.h>
8 #include <deal.II/numerics/data_component_interpretation.h>
9 
10 #include "parameters/parameters_manufactured_solution.h"
11 #include "physics/manufactured_solution.h"
12 
13 namespace PHiLiP {
14 namespace Physics {
15 
17 template <int dim, int nstate, typename real>
18 class ModelBase
19 {
20 public:
22  explicit ModelBase(
23  std::shared_ptr< ManufacturedSolutionFunction<dim,real> > manufactured_solution_function_input = nullptr);
24 
26  virtual ~ModelBase() = default;
27 
29  std::shared_ptr< ManufacturedSolutionFunction<dim,real> > manufactured_solution_function;
30 
31 protected:
32  const MPI_Comm mpi_communicator;
33  dealii::ConditionalOStream pcout;
34 
35 public:
37  virtual std::array<dealii::Tensor<1,dim,real>,nstate>
39  const std::array<real,nstate> &conservative_soln) const = 0;
40 
42  virtual std::array<dealii::Tensor<1,dim,real>,nstate>
44  const std::array<real,nstate> &conservative_soln,
45  const std::array<dealii::Tensor<1,dim,real>,nstate> &solution_gradient,
46  const dealii::types::global_dof_index cell_index) const = 0;
47 
49 
51  virtual std::array<real,nstate> convective_eigenvalues (
52  const std::array<real,nstate> &/*solution*/,
53  const dealii::Tensor<1,dim,real> &/*normal*/) const = 0;
54 
56 
57  virtual real max_convective_eigenvalue (const std::array<real,nstate> &soln) const = 0;
58 
60 
62  const std::array<real,nstate> &soln,
63  const dealii::Tensor<1,dim,real> &normal) const = 0;
64 
66  virtual std::array<real,nstate> physical_source_term (
67  const dealii::Point<dim,real> &pos,
68  const std::array<real,nstate> &solution,
69  const std::array<dealii::Tensor<1,dim,real>,nstate> &solution_gradient,
70  const dealii::types::global_dof_index cell_index) const;
71 
73  virtual std::array<real,nstate> source_term (
74  const dealii::Point<dim,real> &pos,
75  const std::array<real,nstate> &solution,
76  const real current_time,
77  const dealii::types::global_dof_index cell_index) const = 0;
78 
81  const int boundary_type,
82  const dealii::Point<dim, real> &pos,
83  const dealii::Tensor<1,dim,real> &normal,
84  const std::array<real,nstate> &soln_int,
85  const std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_int,
86  std::array<real,nstate> &soln_bc,
87  std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_bc) const;
88 
90 
91  virtual dealii::Vector<double> post_compute_derived_quantities_vector (
92  const dealii::Vector<double> &uh,
93  const std::vector<dealii::Tensor<1,dim> > &/*duh*/,
94  const std::vector<dealii::Tensor<2,dim> > &/*dduh*/,
95  const dealii::Tensor<1,dim> &/*normals*/,
96  const dealii::Point<dim> &/*evaluation_points*/) const;
97 
99 
100  virtual std::vector<dealii::DataComponentInterpretation::DataComponentInterpretation> post_get_data_component_interpretation () const;
101 
103 
104  virtual std::vector<std::string> post_get_names () const;
105 
106  // Quantities needed to be updated by DG for the model -- accomplished by DGBase update_model_variables()
107  dealii::LinearAlgebra::distributed::Vector<int> cellwise_poly_degree;
108  dealii::LinearAlgebra::distributed::Vector<double> cellwise_volume;
109 
110 protected:
112  virtual void boundary_manufactured_solution (
113  const dealii::Point<dim, real> &pos,
114  const dealii::Tensor<1,dim,real> &normal_int,
115  const std::array<real,nstate> &soln_int,
116  const std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_int,
117  std::array<real,nstate> &soln_bc,
118  std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_bc) const;
119 
121  virtual void boundary_wall (
122  std::array<real,nstate> &soln_bc,
123  std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_bc) const;
124 
126  virtual void boundary_outflow (
127  const std::array<real,nstate> &soln_int,
128  const std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_int,
129  std::array<real,nstate> &soln_bc,
130  std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_bc) const;
131 
133  virtual void boundary_inflow (
134  const std::array<real,nstate> &soln_int,
135  const std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_int,
136  std::array<real,nstate> &soln_bc,
137  std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_bc) const;
138 
140  virtual void boundary_farfield (
141  std::array<real,nstate> &soln_bc) const;
142 
143  virtual void boundary_riemann (
144  const dealii::Tensor<1,dim,real> &normal_int,
145  const std::array<real,nstate> &soln_int,
146  std::array<real,nstate> &soln_bc) const;
147 
148  virtual void boundary_slip_wall (
149  const dealii::Tensor<1,dim,real> &normal_int,
150  const std::array<real,nstate> &soln_int,
151  const std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_int,
152  std::array<real,nstate> &soln_bc,
153  std::array<dealii::Tensor<1,dim,real>,nstate> &soln_grad_bc) const;
154 };
155 
156 } // Physics namespace
157 } // PHiLiP namespace
158 
159 #endif
virtual ~ModelBase()=default
Virtual destructor required for abstract classes.
virtual std::vector< dealii::DataComponentInterpretation::DataComponentInterpretation > post_get_data_component_interpretation() const
Returns DataComponentInterpretation of the solution to be used by PhysicsPostprocessor to output curr...
Definition: model.cpp:220
std::shared_ptr< ManufacturedSolutionFunction< dim, real > > manufactured_solution_function
Manufactured solution function.
Definition: model.h:29
virtual void boundary_wall(std::array< real, nstate > &soln_bc, std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_bc) const
Wall boundary condition.
Definition: model.cpp:55
const MPI_Comm mpi_communicator
MPI communicator.
Definition: model.h:32
dealii::ConditionalOStream pcout
Parallel std::cout that only outputs on mpi_rank==0.
Definition: model.h:33
Manufactured solution used for grid studies to check convergence orders.
virtual void boundary_inflow(const std::array< real, nstate > &soln_int, const std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_int, std::array< real, nstate > &soln_bc, std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_bc) const
Inflow boundary conditions.
Definition: model.cpp:85
Files for the baseline physics.
Definition: ADTypes.hpp:10
virtual real max_convective_normal_eigenvalue(const std::array< real, nstate > &soln, const dealii::Tensor< 1, dim, real > &normal) const =0
Maximum convective normal eigenvalue (used in Lax-Friedrichs) of the additional models&#39; PDEs...
ModelBase(std::shared_ptr< ManufacturedSolutionFunction< dim, real > > manufactured_solution_function_input=nullptr)
Constructor.
Definition: model.cpp:15
Physics model additional terms and equations to the baseline physics.
Definition: model.h:18
virtual void boundary_farfield(std::array< real, nstate > &soln_bc) const
Farfield boundary conditions based on freestream values.
Definition: model.cpp:101
virtual std::array< real, nstate > physical_source_term(const dealii::Point< dim, real > &pos, const std::array< real, nstate > &solution, const std::array< dealii::Tensor< 1, dim, real >, nstate > &solution_gradient, const dealii::types::global_dof_index cell_index) const
Physical source terms additional to the baseline physics (including physical source terms in addition...
Definition: model.cpp:24
virtual real max_convective_eigenvalue(const std::array< real, nstate > &soln) const =0
Maximum convective eigenvalue of the additional models&#39; PDEs.
dealii::LinearAlgebra::distributed::Vector< int > cellwise_poly_degree
Cellwise polynomial degree.
Definition: model.h:107
void boundary_face_values(const int boundary_type, const dealii::Point< dim, real > &pos, const dealii::Tensor< 1, dim, real > &normal, const std::array< real, nstate > &soln_int, const std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_int, std::array< real, nstate > &soln_bc, std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_bc) const
Boundary condition handler.
Definition: model.cpp:146
virtual void boundary_outflow(const std::array< real, nstate > &soln_int, const std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_int, std::array< real, nstate > &soln_bc, std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_bc) const
Outflow Boundary Condition.
Definition: model.cpp:69
virtual std::array< dealii::Tensor< 1, dim, real >, nstate > convective_flux(const std::array< real, nstate > &conservative_soln) const =0
Convective flux terms additional to the baseline physics (including convective flux terms in addition...
virtual std::array< dealii::Tensor< 1, dim, real >, nstate > dissipative_flux(const std::array< real, nstate > &conservative_soln, const std::array< dealii::Tensor< 1, dim, real >, nstate > &solution_gradient, const dealii::types::global_dof_index cell_index) const =0
Dissipative flux terms additional to the baseline physics (including dissipative flux terms in additi...
virtual void boundary_manufactured_solution(const dealii::Point< dim, real > &pos, const dealii::Tensor< 1, dim, real > &normal_int, const std::array< real, nstate > &soln_int, const std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_int, std::array< real, nstate > &soln_bc, std::array< dealii::Tensor< 1, dim, real >, nstate > &soln_grad_bc) const
Evaluate the manufactured solution boundary conditions.
Definition: model.cpp:37
virtual dealii::Vector< double > post_compute_derived_quantities_vector(const dealii::Vector< double > &uh, const std::vector< dealii::Tensor< 1, dim > > &, const std::vector< dealii::Tensor< 2, dim > > &, const dealii::Tensor< 1, dim > &, const dealii::Point< dim > &) const
Returns current vector solution to be used by PhysicsPostprocessor to output current solution...
Definition: model.cpp:192
virtual std::array< real, nstate > convective_eigenvalues(const std::array< real, nstate > &, const dealii::Tensor< 1, dim, real > &) const =0
Convective eigenvalues of the additional models&#39; PDEs.
virtual std::array< real, nstate > source_term(const dealii::Point< dim, real > &pos, const std::array< real, nstate > &solution, const real current_time, const dealii::types::global_dof_index cell_index) const =0
Manufactured source terms additional to the baseline physics (including manufactured source terms in ...
virtual std::vector< std::string > post_get_names() const
Returns names of the solution to be used by PhysicsPostprocessor to output current solution...
Definition: model.cpp:208