libMesh
Loading...
Searching...
No Matches
rb_scm_evaluation.h
Go to the documentation of this file.
1// rbOOmit: An implementation of the Certified Reduced Basis method.
2// Copyright (C) 2009, 2010 David J. Knezevic
3
4// This file is part of rbOOmit.
5
6// rbOOmit is free software; you can redistribute it and/or
7// modify it under the terms of the GNU Lesser General Public
8// License as published by the Free Software Foundation; either
9// version 2.1 of the License, or (at your option) any later version.
10
11// rbOOmit is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14// Lesser General Public License for more details.
15
16// You should have received a copy of the GNU Lesser General Public
17// License along with this library; if not, write to the Free Software
18// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
20#ifndef LIBMESH_RB_SCM_EVALUATION_H
21#define LIBMESH_RB_SCM_EVALUATION_H
22
23// RBSCMEvaluation should only be available
24// if SLEPc and GLPK support is enabled.
25#include "libmesh/libmesh_config.h"
26#if defined(LIBMESH_HAVE_SLEPC) && (LIBMESH_HAVE_GLPK)
27
28// rbOOmit includes
29#include "libmesh/rb_parametrized.h"
30
31// libMesh includes
32#include "libmesh/parallel_object.h"
33
34// C++ includes
35
36namespace libMesh
37{
38
39// Forward declarations
40class RBThetaExpansion;
41
53 public ParallelObject
54{
55public:
56
61
65 virtual ~RBSCMEvaluation ();
66
70 void set_rb_theta_expansion(RBThetaExpansion & rb_theta_expansion_in);
71
76
80 virtual Real get_SCM_LB();
81
85 virtual Real get_SCM_UB();
86
93 Real get_C_J_stability_constraint(unsigned int j) const;
94
101 void set_C_J_stability_constraint(unsigned int j, Real stability_constraint_in);
102
108 Real get_SCM_UB_vector(unsigned int j, unsigned int q);
109
115 void set_SCM_UB_vector(unsigned int j, unsigned int q, Real y_q);
116
120 unsigned int get_C_J_size()
121 { return cast_int<unsigned int>(C_J.size()); }
122
126 const RBParameters & get_C_J_entry(unsigned int j);
127
131 Real get_C_J_stability_value(unsigned int j) { return C_J_stability_vector[j]; }
132
136 Real get_B_min(unsigned int i) const;
137 Real get_B_max(unsigned int i) const;
138
142 void set_B_min(unsigned int i, Real B_min_val);
143 void set_B_max(unsigned int i, Real B_max_val);
144
149 virtual void save_current_parameters();
150
155 virtual void reload_current_parameters();
156
160 virtual void set_current_parameters_from_C_J(unsigned int C_J_index);
161
168 virtual void legacy_write_offline_data_to_files(const std::string & directory_name = "offline_data",
169 const bool write_binary_data = true);
170
177 virtual void legacy_read_offline_data_from_files(const std::string & directory_name = "offline_data",
178 const bool read_binary_data = true);
179
180 //----------- PUBLIC DATA MEMBERS -----------//
181
185 std::vector<Real> B_min;
186 std::vector<Real> B_max;
187
192 std::vector<RBParameters > C_J;
193
198 std::vector<Real> C_J_stability_vector;
199
206 std::vector<std::vector<Real>> SCM_UB_vectors;
207
208private:
209
215
223
224};
225
226}
227
228#endif // LIBMESH_HAVE_SLEPC && LIBMESH_HAVE_GLPK
229
230#endif // LIBMESH_RB_SCM_EVALUATION_H
An object whose state is distributed along a set of processors.
const Parallel::Communicator & comm() const
This class is part of the rbOOmit framework.
This class is part of the rbOOmit framework.
This class is part of the rbOOmit framework.
unsigned int get_C_J_size()
Get size of the set C_J.
virtual ~RBSCMEvaluation()
Destructor.
virtual void legacy_read_offline_data_from_files(const std::string &directory_name="offline_data", const bool read_binary_data=true)
Read in the saved Offline reduced basis data to initialize the system for Online solves.
Real get_B_min(unsigned int i) const
Get B_min and B_max.
Real get_C_J_stability_constraint(unsigned int j) const
Get stability constraints (i.e.
std::vector< Real > B_max
Real get_SCM_UB_vector(unsigned int j, unsigned int q)
Get entries of SCM_UB_vector, which stores the vector y, corresponding to the minimizing eigenvectors...
virtual Real get_SCM_LB()
Evaluate single SCM lower bound.
RBParameters saved_parameters
Vector in which to save a parameter set.
RBThetaExpansion & get_rb_theta_expansion()
Get a reference to the rb_theta_expansion.
Real get_B_max(unsigned int i) const
void set_SCM_UB_vector(unsigned int j, unsigned int q, Real y_q)
Set entries of SCM_UB_vector, which stores the vector y, corresponding to the minimizing eigenvectors...
virtual void set_current_parameters_from_C_J(unsigned int C_J_index)
Set parameters based on values saved in "C_J".
virtual Real get_SCM_UB()
Evaluate single SCM upper bound.
virtual void legacy_write_offline_data_to_files(const std::string &directory_name="offline_data", const bool write_binary_data=true)
Write out all the data to text files in order to segregate the Offline stage from the Online stage.
RBThetaExpansion * rb_theta_expansion
A pointer to to the object that stores the theta expansion.
void set_B_max(unsigned int i, Real B_max_val)
std::vector< Real > C_J_stability_vector
Vector storing the (truth) stability values at the parameters in C_J.
std::vector< Real > B_min
B_min, B_max define the bounding box.
virtual void reload_current_parameters()
Helper function to (re)load current_parameters from saved_parameters.
void set_C_J_stability_constraint(unsigned int j, Real stability_constraint_in)
Set stability constraints (i.e.
std::vector< std::vector< Real > > SCM_UB_vectors
This matrix stores the infimizing vectors y_1( ),...,y_Q_a( ), for each in C_J, which are used in co...
Real get_C_J_stability_value(unsigned int j)
Get entry of C_J_stability_vector.
void set_B_min(unsigned int i, Real B_min_val)
Set B_min and B_max.
void set_rb_theta_expansion(RBThetaExpansion &rb_theta_expansion_in)
Set the RBThetaExpansion object.
const RBParameters & get_C_J_entry(unsigned int j)
Get entry of C_J.
virtual void save_current_parameters()
Helper function to save current_parameters in saved_parameters.
std::vector< RBParameters > C_J
Vector storing the greedily selected parameters during SCM training.
This class stores the set of RBTheta functor objects that define the "parameter-dependent expansion" ...
The libMesh namespace provides an interface to certain functionality in the library.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real