libMesh::RBParametrized Class Reference

#include <rb_parametrized.h>

Inheritance diagram for libMesh::RBParametrized:

Public Member Functions
	RBParametrized ()
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
std::set< std::string >	get_parameter_names () 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_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 Public Member Functions
static Real	get_closest_value (Real value, const std::vector< Real > &list_of_values)
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
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	valid_params (const RBParameters &params)

Static Private Member Functions
static bool	is_value_in_list (Real value, const std::vector< Real > &list_of_values, Real tol)

Private Attributes
bool	parameters_initialized
RBParameters	parameters
RBParameters	parameters_min
RBParameters	parameters_max
std::map< std::string, std::vector< Real > >	_discrete_parameter_values

Detailed Description

This class is part of the rbOOmit framework.

This class defines basic functionality of a parametrized object.

Author

David J. Knezevic

Date

2011

Definition at line 44 of file rb_parametrized.h.

Member Typedef Documentation

Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

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

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

RBParametrized()

libMesh::RBParametrized::RBParametrized

(

)

Constructor.

~RBParametrized()

virtual libMesh::RBParametrized::~RBParametrized ( )

virtual

Destructor.

Member Function Documentation

clear()

virtual void libMesh::RBParametrized::clear ( )

virtual

Clear all the data structures associated with the system.

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

disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit().

{
  _enable_print_counter = false;
  return;
}

enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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;
}

get_closest_value()

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

static

Returns

The closest entry to value from list_of_values.

get_discrete_parameter_values()

const std::map<std::string, std::vector<Real> >& libMesh::RBParametrized::get_discrete_parameter_values

(

)

const

Get a const reference to the discrete parameter values.

get_info()

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

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 (const auto & pr : _counts)
    {
      const std::string name(pr.first);
      const unsigned int creations    = pr.second.first;
      const unsigned int destructions = pr.second.second;

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

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

  return oss.str();

#else

  return "";

#endif
}

get_n_continuous_params()

unsigned int libMesh::RBParametrized::get_n_continuous_params

(

)

const

Get the number of continuous parameters.

get_n_discrete_params()

unsigned int libMesh::RBParametrized::get_n_discrete_params

(

)

const

Get the number of discrete parameters.

get_n_params()

unsigned int libMesh::RBParametrized::get_n_params

(

)

const

Get the number of parameters.

get_parameter_max()

Real libMesh::RBParametrized::get_parameter_max

(

const std::string &

param_name

)

const

Get maximum allowable value of parameter param_name.

get_parameter_min()

Real libMesh::RBParametrized::get_parameter_min

(

const std::string &

param_name

)

const

Get minimum allowable value of parameter param_name.

get_parameter_names()

std::set<std::string> libMesh::RBParametrized::get_parameter_names

(

)

const

Get a set that stores the parameter names.

get_parameters()

const RBParameters& libMesh::RBParametrized::get_parameters

(

)

const

Get the current parameters.

get_parameters_max()

const RBParameters& libMesh::RBParametrized::get_parameters_max

(

)

const

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

get_parameters_min()

const RBParameters& libMesh::RBParametrized::get_parameters_min

(

)

const

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

increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name )

inlineprotectedinherited

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

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), 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++;
}

increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name )

inlineprotectedinherited

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

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), 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++;
}

initialize_parameters() [1/2]

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

Initialize the parameter ranges and set current_parameters.

initialize_parameters() [2/2]

void libMesh::RBParametrized::initialize_parameters

(

const RBParametrized &

rb_parametrized

)

Initialize the parameter ranges and set current_parameters.

is_discrete_parameter()

bool libMesh::RBParametrized::is_discrete_parameter

(

const std::string &

mu_name

)

const

Is parameter mu_name discrete?

is_value_in_list()

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

staticprivate

Helper function to check if the specified value is in the list of values (within a tolerance given by tol).

n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

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

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

  { return _n_objects; }

print_discrete_parameter_values()

void libMesh::RBParametrized::print_discrete_parameter_values

(

)

const

Print out all the discrete parameter values.

print_info()

void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out )

staticinherited

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

Definition at line 87 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();
}

print_parameters()

void libMesh::RBParametrized::print_parameters

(

)

const

Print the current parameters.

read_discrete_parameter_values_from_file()

void libMesh::RBParametrized::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  )

private

Read in the discrete parameter values from file, if we have any.

read_parameter_data_from_files()

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

Read in the parameter ranges from files.

read_parameter_ranges_from_file()

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

private

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

set_parameters()

void libMesh::RBParametrized::set_parameters

(

const RBParameters &

params

)

Set the current parameters to params

valid_params()

bool libMesh::RBParametrized::valid_params ( const RBParameters &  params )

private

Helper function to check that params is valid.

write_discrete_parameter_values_to_file()

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

private

Write out the discrete parameter values to file.

write_parameter_data_to_files()

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

Write out the parameter ranges to files.

write_parameter_ranges_to_file()

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

private

Write out the parameter ranges to file.

Member Data Documentation

_counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

_discrete_parameter_values

std::map<std::string, std::vector<Real> > libMesh::RBParametrized::_discrete_parameter_values

private

Map that defines the allowable values of any discrete parameters.

Definition at line 235 of file rb_parametrized.h.

_enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

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

_mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

_n_objects

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

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

Definition at line 130 of file reference_counter.h.

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

parameters

RBParameters libMesh::RBParametrized::parameters

private

Vector storing the current parameters.

Definition at line 224 of file rb_parametrized.h.

parameters_initialized

bool libMesh::RBParametrized::parameters_initialized

private

Flag indicating whether the parameters have been initialized.

Definition at line 219 of file rb_parametrized.h.

parameters_max

RBParameters libMesh::RBParametrized::parameters_max

private

Definition at line 230 of file rb_parametrized.h.

parameters_min

RBParameters libMesh::RBParametrized::parameters_min

private

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

Definition at line 229 of file rb_parametrized.h.

verbose_mode

bool libMesh::RBParametrized::verbose_mode

Public boolean to toggle verbose mode.

Definition at line 170 of file rb_parametrized.h.

---

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

• rb_parametrized.h