rb_parameters.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_PARAMETERS_H
#define LIBMESH_RB_PARAMETERS_H
 
// libMesh includes
#include "libmesh/libmesh_common.h"
 
// C++ includes
#include <string>
#include <map>
#include <set>
 
namespace libMesh
{
 
class RBParameters
{
public:
 
  RBParameters () = default;
  RBParameters (RBParameters &&) = default;
  RBParameters (const RBParameters &) = default;
  RBParameters & operator= (const RBParameters &) = default;
  RBParameters & operator= (RBParameters &&) = default;
  ~RBParameters() = default;
 
  RBParameters(const std::map<std::string, Real> & parameter_map);
 
  // Define a constant iterator for this class
  typedef std::map<std::string, Real>::const_iterator const_iterator;
 
  void clear();
 
  Real get_value(const std::string & param_name) const;
 
  void set_value(const std::string & param_name, Real value);
 
  Real get_extra_value(const std::string & param_name) const;
 
  void set_extra_value(const std::string & param_name, Real value);
 
  unsigned int n_parameters() const;
 
  void get_parameter_names(std::set<std::string> & param_names) const;
 
  void get_extra_parameter_names(std::set<std::string> & param_names) const;
 
  const_iterator begin() const;
  const_iterator end() const;
 
  const_iterator extra_begin() const;
  const_iterator extra_end() const;
 
  bool operator== (const RBParameters & rhs) const;
 
  bool operator!= (const RBParameters & node) const;
 
  std::string get_string(unsigned int precision=6) const;
 
  void print() const;
 
private:
 
  std::map<std::string, Real> _parameters;
 
  std::map<std::string, Real> _extra_parameters;
 
};
 
} // namespace libMesh
 
 
#endif // LIBMESH_RB_PARAMETERS_H