Flow123d  release_3.0.0-1106-ga3b2e4c
first_order_reaction_base.cc
Go to the documentation of this file.
1 /*!
2  *
3  * Copyright (C) 2015 Technical University of Liberec. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it under
6  * the terms of the GNU General Public License version 3 as published by the
7  * Free Software Foundation. (http://www.gnu.org/licenses/gpl-3.0.en.html)
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12  *
13  *
14  * @file first_order_reaction_base.cc
15  * @brief
16  */
17 
20 
22 
23 
24 #include "system/global_defs.h"
25 #include "system/sys_profiler.hh"
26 
27 #include "mesh/mesh.h"
28 #include "la/distribution.hh"
29 #include "input/accessors.hh"
30 
31 
32 
33 using namespace Input::Type;
34 
35 
37  : ReactionTerm(init_mesh, in_rec)
38 {
39  linear_ode_solver_ = std::make_shared<LinearODESolver>();
40 }
41 
43 {
44 }
45 
47 {
48  OLD_ASSERT(distribution_ != nullptr, "Distribution has not been set yet.\n");
49  OLD_ASSERT(time_ != nullptr, "Time governor has not been set yet.\n");
51 
54 
55  // allocation
56  prev_conc_.resize(n_substances_);
57  reaction_matrix_.resize(n_substances_, n_substances_);
58  molar_matrix_.resize(n_substances_, n_substances_);
59  molar_mat_inverse_.resize(n_substances_, n_substances_);
60 
61  // initialize diagonal matrices with molar masses
62  molar_matrix_.zeros();
63  molar_mat_inverse_.zeros();
64  for (unsigned int i=0; i<n_substances_; ++i)
65  {
66  molar_matrix_(i,i) = substances_[i].molar_mass();
67  molar_mat_inverse_(i,i) = 1./substances_[i].molar_mass();
68  }
69 }
70 
71 
73 {
74  OLD_ASSERT(distribution_ != nullptr, "Distribution has not been set yet.\n");
75  OLD_ASSERT(time_ != nullptr, "Time governor has not been set yet.\n");
77 
79  // make scaling that takes into account different molar masses of substances
81 
82  linear_ode_solver_->set_system_matrix(reaction_matrix_);
83 }
84 
85 
86 double **FirstOrderReactionBase::compute_reaction(double **concentrations, int loc_el) //multiplication of concentrations array by reaction matrix
87 {
88  unsigned int rows; // row in the concentration matrix, regards the substance index
89  arma::vec new_conc;
90 
91  // save previous concentrations to column vector
92  for(rows = 0; rows < n_substances_; rows++)
93  prev_conc_(rows) = concentrations[rows][loc_el];
94 
95  // compute new concetrations R*c
96  linear_ode_solver_->update_solution(prev_conc_, new_conc);
97 
98  // save new concentrations to the concentration matrix
99  for(rows = 0; rows < n_substances_; rows++)
100  concentrations[rows][loc_el] = new_conc(rows);
101 
102  return concentrations;
103 }
104 
106 {
107  //DebugOut() << "FirstOrderReactionBases - update solution\n";
108  if(time_->is_changed_dt())
109  {
110  linear_ode_solver_->set_step(time_->dt());
111  }
112 
113  START_TIMER("linear reaction step");
114 
115  for (unsigned int loc_el = 0; loc_el < distribution_->lsize(); loc_el++)
117 
118  END_TIMER("linear reaction step");
119 }
120 
121 
122 unsigned int FirstOrderReactionBase::find_subst_name(const string &name)
123 {
124  unsigned int k=0;
125  for(; k < n_substances_; k++)
126  if (name == substances_[k].name()) return k;
127 
128  return k;
129 }
130 
131 
133 {
134  if (!linear_ode_solver_->evaluate_time_constraint(time_constraint)) return false;
135 
136  DebugOut().fmt("CFL constraint(first order reaction): {}.\n", time_constraint);
137 
138  return true;
139 }
virtual void initialize_from_input()=0
Initializes private members of sorption from the input record.
arma::mat molar_matrix_
Diagonal matrix with molar masses of substances.
double ** concentration_matrix_
void initialize() override
Prepares the object to usage.
void zero_time_step() override
Moves the model to zero time.
SubstanceList substances_
Names belonging to substances.
Definition: mesh.h:76
unsigned int find_subst_name(const std::string &name)
virtual void assemble_ode_matrix(void)=0
Assembles the matrix of the ODEs.
unsigned int size() const
Definition: substance.hh:87
Class ReactionTerm is an abstract class representing reaction term in transport.
#define OLD_ASSERT(...)
Definition: global_defs.h:131
void update_solution(void) override
Updates the solution.
Global macros to enhance readability and debugging, general constants.
arma::mat reaction_matrix_
Reaction matrix.
Distribution * distribution_
Pointer to reference to distribution of elements between processors.
FirstOrderReactionBase(Mesh &init_mesh, Input::Record in_rec)
Constructor.
Accessor to the data with type Type::Record.
Definition: accessors.hh:292
bool is_changed_dt() const
#define START_TIMER(tag)
Starts a timer with specified tag.
#define OLD_ASSERT_LESS(a, b)
Definition: global_defs.h:134
Support classes for parallel programing.
std::shared_ptr< LinearODESolver > linear_ode_solver_
arma::vec prev_conc_
Column vector storing previous concetrations on an element.
double dt() const
arma::mat molar_mat_inverse_
Inverse of molar_matrix_.
#define END_TIMER(tag)
Ends a timer with specified tag.
unsigned int n_substances_
Number of all transported substances. It is the dimension of the reaction matrix. ...
virtual double ** compute_reaction(double **concentrations, int loc_el) override
Computes the reaction on a specified element.
#define DebugOut()
Macro defining &#39;debug&#39; record of log.
Definition: logger.hh:252
~FirstOrderReactionBase(void)
Destructor.
bool evaluate_time_constraint(double &time_constraint) override
Computes a constraint for time step.
TimeGovernor * time_
Definition: equation.hh:224
unsigned int lsize(int proc) const
get local size