libMesh::RBParametrized Class Reference

#include <rb_parametrized.h>

Inheritance diagram for libMesh::RBParametrized:

[legend]

List of all members.

Public Member Functions
	RBParametrized ()
virtual	~RBParametrized ()
virtual void	clear ()
void	initialize_parameters (const RBParameters &mu_min_in, const RBParameters &mu_max_in, const RBParameters &mu_in)
void	initialize_parameters (const RBParametrized &rb_parametrized)
virtual void	initialize_parameters (const std::string &parameters_filename)
unsigned int	get_n_params () const
const RBParameters &	get_parameters () const
void	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_ranges_to_file (const std::string &file_name, const bool write_binary)
void	read_parameter_ranges_from_file (const std::string &file_name, const bool read_binary)
Static Public Member Functions
static std::string	get_info ()
static void	print_info (std::ostream &out=libMesh::out)
static unsigned int	n_objects ()
static void	enable_print_counter_info ()
static void	disable_print_counter_info ()
Public Attributes
bool	verbose_mode
Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
Protected Member Functions
void	increment_constructor_count (const std::string &name)
void	increment_destructor_count (const std::string &name)
Static Protected Attributes
static Counts	_counts
static Threads::atomic < unsigned int >	_n_objects
static Threads::spin_mutex	_mutex
static bool	_enable_print_counter = true
Private Member Functions
bool	valid_params (const RBParameters &params)
Private Attributes
bool	parameters_initialized
RBParameters	parameters
RBParameters	parameters_min
RBParameters	parameters_max

---

Detailed Description

This class is part of the rbOOmit framework.

This class defines basic functionality of a parametrized object.

Author:

David J. Knezevic, 2011

Definition at line 45 of file rb_parametrized.h.

---

Member Typedef Documentation

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts [protected, inherited]

Data structure to log the information. The log is identified by the class name.

Definition at line 113 of file reference_counter.h.

---

Constructor & Destructor Documentation

libMesh::RBParametrized::RBParametrized

(

)

Constructor.

virtual libMesh::RBParametrized::~RBParametrized

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void libMesh::RBParametrized::clear

(

)

[virtual]

Clear all the data structures associated with the system.

Reimplemented in libMesh::RBConstruction, libMesh::RBConstructionBase< Base >, libMesh::RBEIMConstruction, libMesh::RBEIMEvaluation, libMesh::RBEvaluation, libMesh::RBSCMConstruction, libMesh::TransientRBConstruction, libMesh::TransientRBEvaluation, libMesh::RBConstructionBase< LinearImplicitSystem >, libMesh::RBConstructionBase< CondensedEigenSystem >, and libMesh::TransientSystem< RBConstruction >.

void libMesh::ReferenceCounter::disable_print_counter_info

(

)

[static, inherited]

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = false;
  return;
}

void libMesh::ReferenceCounter::enable_print_counter_info

(

)

[static, inherited]

Methods to enable/disable the reference counter output from print_info()

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = true;
  return;
}

std::string libMesh::ReferenceCounter::get_info

(

)

[static, inherited]

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

Referenced by libMesh::ReferenceCounter::print_info().

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)

  std::ostringstream oss;

  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";

  for (Counts::iterator it = _counts.begin();
       it != _counts.end(); ++it)
    {
      const std::string name(it->first);
      const unsigned int creations    = it->second.first;
      const unsigned int destructions = it->second.second;

      oss << "| " << name << " reference count information:\n"
          << "|  Creations:    " << creations    << '\n'
          << "|  Destructions: " << destructions << '\n';
    }

  oss << " ---------------------------------------------------------------------------- \n";

  return oss.str();

#else

  return "";

#endif
}

unsigned int libMesh::RBParametrized::get_n_params

(

)

const

Get the number of parameters.

Real libMesh::RBParametrized::get_parameter_max

(

const std::string &

param_name

)

const

Get maximum allowable value of parameter param_name.

Real libMesh::RBParametrized::get_parameter_min

(

const std::string &

param_name

)

const

Get minimum allowable value of parameter param_name.

const RBParameters& libMesh::RBParametrized::get_parameters

(

)

const

Get the current parameters.

const RBParameters& libMesh::RBParametrized::get_parameters_max

(

)

const

Get an RBParameters object that specifies the maximum allowable value for each parameter.

const RBParameters& libMesh::RBParametrized::get_parameters_min

(

)

const

Get an RBParameters object that specifies the minimum allowable value for each parameter.

void libMesh::ReferenceCounter::increment_constructor_count

(

const std::string &

name

)

[inline, protected, inherited]

Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.

Definition at line 163 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.first++;
}

void libMesh::ReferenceCounter::increment_destructor_count

(

const std::string &

name

)

[inline, protected, inherited]

Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.

Definition at line 176 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.second++;
}

virtual void libMesh::RBParametrized::initialize_parameters

(

const std::string &

parameters_filename

)

[virtual]

Initialize the parameter ranges and set current_parameters by reading in data from the file input_filename

void libMesh::RBParametrized::initialize_parameters

(

const RBParametrized &

rb_parametrized

)

Initialize the parameter ranges and set current_parameters.

void libMesh::RBParametrized::initialize_parameters	(	const RBParameters &	mu_min_in,
		const RBParameters &	mu_max_in,
		const RBParameters &	mu_in
	)

Initialize the parameter ranges and set current_parameters.

static unsigned int libMesh::ReferenceCounter::n_objects

(

)

[inline, static, inherited]

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 79 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

  { return _n_objects; }

void libMesh::ReferenceCounter::print_info

(

std::ostream &

out = libMesh::out

)

[static, inherited]

Prints the reference information, by default to libMesh::out.

Definition at line 88 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

{
  if( _enable_print_counter ) out_stream << ReferenceCounter::get_info();
}

void libMesh::RBParametrized::print_parameters

(

)

const

Print the current parameters.

void libMesh::RBParametrized::read_parameter_ranges_from_file	(	const std::string &	file_name,
		const bool	read_binary
	)

Read in the parameter ranges from file. Initialize parameters to the "minimum" parameter values.

void libMesh::RBParametrized::set_parameters

(

const RBParameters &

params

)

Set the current parameters to params

bool libMesh::RBParametrized::valid_params

(

const RBParameters &

params

)

[private]

Helper function to check that params is valid.

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

Write out the parameter ranges to file.

---

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts [static, protected, inherited]

Actually holds the data.

Definition at line 118 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

bool libMesh::ReferenceCounter::_enable_print_counter = true [static, protected, inherited]

Flag to control whether reference count information is printed when print_info is called.

Definition at line 137 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

Threads::spin_mutex libMesh::ReferenceCounter::_mutex [static, protected, inherited]

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 131 of file reference_counter.h.

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects [static, protected, inherited]

The number of objects. Print the reference count information when the number returns to 0.

Definition at line 126 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

RBParameters libMesh::RBParametrized::parameters [private]

Vector storing the current parameters.

Definition at line 160 of file rb_parametrized.h.

bool libMesh::RBParametrized::parameters_initialized [private]

Flag indicating whether the parameters have been initialized.

Definition at line 155 of file rb_parametrized.h.

RBParameters libMesh::RBParametrized::parameters_max [private]

Definition at line 166 of file rb_parametrized.h.

RBParameters libMesh::RBParametrized::parameters_min [private]

Vectors that define the ranges (min and max) for the parameters.

Definition at line 165 of file rb_parametrized.h.

bool libMesh::RBParametrized::verbose_mode

Public boolean to toggle verbose mode.

Definition at line 141 of file rb_parametrized.h.

---

The documentation for this class was generated from the following file:

• rb_parametrized.h