rb_parametrized.h

Go to the documentation of this file.

// rbOOmit: An implementation of the Certified Reduced Basis method.
// Copyright (C) 2009, 2010 David J. Knezevic

// This file is part of rbOOmit.

// rbOOmit 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.

// rbOOmit 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 LIBMESH_RB_PARAMETRIZED_H
#define LIBMESH_RB_PARAMETRIZED_H

// rbOOmit includes
#include "libmesh/rb_parameters.h"

// libMesh includes
#include "libmesh/reference_counted_object.h"

// C++ includes
#include <cstddef>
#include <vector>

namespace libMesh
{

class RBParametrized : public ReferenceCountedObject<RBParametrized>
{
public:

  RBParametrized ();

  RBParametrized (RBParametrized &&) = default;
  RBParametrized & operator= (RBParametrized &&) = default;
  RBParametrized (const RBParametrized &) = default;
  RBParametrized & operator= (const RBParametrized &) = default;
  virtual ~RBParametrized ();

  virtual void clear ();

  void initialize_parameters(const RBParameters & mu_min_in,
                             const RBParameters & mu_max_in,
                             const std::map<std::string, std::vector<Real>> & discrete_parameter_values);

  void initialize_parameters(const RBParametrized & rb_parametrized);

  unsigned int get_n_params() const;

  unsigned int get_n_continuous_params() const;

  unsigned int get_n_discrete_params() const;

#ifdef LIBMESH_ENABLE_DEPRECATED

  std::set<std::string> get_parameter_names() const;
#endif // LIBMESH_ENABLE_DEPRECATED

  const RBParameters & get_parameters() const;

  bool set_parameters(const RBParameters & params);

  const RBParameters & get_parameters_min() const;

  const RBParameters & get_parameters_max() const;

  Real get_parameter_min(const std::string & param_name) const;

  Real get_parameter_max(const std::string & param_name) const;

  void print_parameters() const;

  void write_parameter_data_to_files(const std::string & continuous_param_file_name,
                                     const std::string & discrete_param_file_name,
                                     const bool write_binary_data);

  void read_parameter_data_from_files(const std::string & continuous_param_file_name,
                                      const std::string & discrete_param_file_name,
                                      const bool read_binary_data);

  bool is_discrete_parameter(const std::string & mu_name) const;

  const std::map<std::string, std::vector<Real>> & get_discrete_parameter_values() const;

  void print_discrete_parameter_values() const;

  static Real get_closest_value(Real value, const std::vector<Real> & list_of_values);

  bool verbose_mode;

private:

  void write_parameter_ranges_to_file(const std::string & file_name,
                                      const bool write_binary);

  void write_discrete_parameter_values_to_file(const std::string & file_name,
                                               const bool write_binary_data);

  void read_parameter_ranges_from_file(const std::string & file_name,
                                       const bool read_binary,
                                       RBParameters & param_min,
                                       RBParameters & param_max);

  void read_discrete_parameter_values_from_file(const std::string & file_name,
                                                const bool read_binary_data,
                                                std::map<std::string, std::vector<Real>> & discrete_parameter_values_in);

  bool check_if_valid_params(const RBParameters & params) const;

  static bool is_value_in_list(Real value, const std::vector<Real> & list_of_values, Real tol);

  //--------------- PRIVATE DATA MEMBERS ---------------//

  bool parameters_initialized;

  RBParameters parameters;

  RBParameters parameters_min;
  RBParameters parameters_max;

  std::map<std::string, std::vector<Real>> _discrete_parameter_values;
};

} // namespace libMesh


#endif // LIBMESH_RB_PARAMETRIZED_H