This class is part of the rbOOmit framework. More...

#include <rb_eim_evaluation.h>

Inheritance diagram for libMesh::RBEIMEvaluation:

Public Types
typedef RBEvaluation	Parent
	The type of the parent. More...

Public Member Functions
	RBEIMEvaluation (const libMesh::Parallel::Communicator &comm_in)
	Constructor. More...

virtual	~RBEIMEvaluation ()
	Destructor. More...

virtual void	clear () override
	Clear this object. More...

virtual void	resize_data_structures (const unsigned int Nmax, bool resize_error_bound_data=true) override
	Resize the data structures for storing data associated with this object. More...

void	attach_parametrized_function (RBParametrizedFunction *pf)
	Attach the parametrized function that we will approximate using the Empirical Interpolation Method. More...

unsigned int	get_n_parametrized_functions () const
	Get the number of parametrized functions that have been attached to this system. More...

ReplicatedMesh &	get_interpolation_points_mesh ()
	Get a writable reference to the interpolation points mesh. More...

Number	evaluate_parametrized_function (unsigned int var_index, const Point &p, const Elem &elem)

virtual Real	rb_solve (unsigned int N) override
	Calculate the EIM approximation to parametrized_function using the first `N` EIM basis functions. More...

void	rb_solve (DenseVector< Number > &EIM_rhs)
	Calculate the EIM approximation for the given right-hand side vector `EIM_rhs`. More...

virtual Real	get_error_bound_normalization () override

void	initialize_eim_theta_objects ()
	Build a vector of RBTheta objects that accesses the components of the RB_solution member variable of this RBEvaluation. More...

std::vector< std::unique_ptr< RBTheta > > &	get_eim_theta_objects ()

virtual std::unique_ptr< RBTheta >	build_eim_theta (unsigned int index)
	Build a theta object corresponding to EIM index `index`. More...

virtual void	legacy_write_offline_data_to_files (const std::string &directory_name="offline_data", const bool write_binary_data=true) override
	Write out all the data to text files in order to segregate the Offline stage from the Online stage. More...

virtual void	legacy_read_offline_data_from_files (const std::string &directory_name="offline_data", bool read_error_bound_data=true, const bool read_binary_data=true) override
	Read in the saved Offline reduced basis data to initialize the system for Online solves. More...

void	set_rb_theta_expansion (RBThetaExpansion &rb_theta_expansion_in)
	Set the RBThetaExpansion object. More...

RBThetaExpansion &	get_rb_theta_expansion ()
	Get a reference to the rb_theta_expansion. More...

bool	is_rb_theta_expansion_initialized () const

NumericVector< Number > &	get_basis_function (unsigned int i)
	Get a reference to the i^th basis function. More...

virtual Real	compute_residual_dual_norm (const unsigned int N)
	Compute the dual norm of the residual for the solution saved in RB_solution_vector. More...

virtual Real	residual_scaling_denom (Real alpha_LB)
	Specifies the residual scaling on the denominator to be used in the a posteriori error bound. More...

Real	eval_output_dual_norm (unsigned int n, const RBParameters &mu)
	Evaluate the dual norm of output `n` for the current parameters. More...

virtual Real	get_stability_lower_bound ()
	Get a lower bound for the stability constant (e.g. More...

virtual unsigned int	get_n_basis_functions () const
	Get the current number of basis functions. More...

virtual void	set_n_basis_functions (unsigned int n_bfs)
	Set the number of basis functions. More...

virtual void	clear_riesz_representors ()
	Clear all the Riesz representors that are used to compute the RB residual (and hence error bound). More...

virtual void	write_out_basis_functions (System &sys, const std::string &directory_name="offline_data", const bool write_binary_basis_functions=true)
	Write out all the basis functions to file. More...

virtual void	write_out_vectors (System &sys, std::vector< NumericVector< Number > *> &vectors, const std::string &directory_name="offline_data", const std::string &data_name="bf", const bool write_binary_basis_functions=true)
	Same as write_out_basis_functions, except in this case we pass in the vectors to be written. More...

virtual void	read_in_basis_functions (System &sys, const std::string &directory_name="offline_data", const bool read_binary_basis_functions=true)
	Read in all the basis functions from file. More...

void	read_in_vectors (System &sys, std::vector< std::unique_ptr< NumericVector< Number >>> &vectors, const std::string &directory_name, const std::string &data_name, const bool read_binary_vectors)
	Same as read_in_basis_functions, except in this case we pass in the vectors to be written. More...

void	read_in_vectors_from_multiple_files (System &sys, std::vector< std::vector< std::unique_ptr< NumericVector< Number >>> *> multiple_vectors, const std::vector< std::string > &multiple_directory_names, const std::vector< std::string > &multiple_data_names, const bool read_binary_vectors)
	Performs read_in_vectors for a list of directory names and data names. More...

void	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. More...

void	initialize_parameters (const RBParametrized &rb_parametrized)
	Initialize the parameter ranges and set current_parameters. More...

unsigned int	get_n_params () const
	Get the number of parameters. More...

unsigned int	get_n_continuous_params () const
	Get the number of continuous parameters. More...

unsigned int	get_n_discrete_params () const
	Get the number of discrete parameters. More...

std::set< std::string >	get_parameter_names () const
	Get a set that stores the parameter names. More...

const RBParameters &	get_parameters () const
	Get the current parameters. More...

void	set_parameters (const RBParameters &params)
	Set the current parameters to `params`. More...

const RBParameters &	get_parameters_min () const
	Get an RBParameters object that specifies the minimum allowable value for each parameter. More...

const RBParameters &	get_parameters_max () const
	Get an RBParameters object that specifies the maximum allowable value for each parameter. More...

Real	get_parameter_min (const std::string &param_name) const
	Get minimum allowable value of parameter `param_name`. More...

Real	get_parameter_max (const std::string &param_name) const
	Get maximum allowable value of parameter `param_name`. More...

void	print_parameters () const
	Print the current parameters. More...

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)
	Write out the parameter ranges to files. More...

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)
	Read in the parameter ranges from files. More...

bool	is_discrete_parameter (const std::string &mu_name) const
	Is parameter `mu_name` discrete? More...

const std::map< std::string, std::vector< Real > > &	get_discrete_parameter_values () const
	Get a const reference to the discrete parameter values. More...

void	print_discrete_parameter_values () const
	Print out all the discrete parameter values. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static Real	get_closest_value (Real value, const std::vector< Real > &list_of_values)

static std::string	get_info ()
	Gets a string containing the reference information. More...

static void	print_info (std::ostream &out=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. More...

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

Public Attributes
DenseMatrix< Number >	interpolation_matrix
	Dense matrix that stores the lower triangular interpolation matrix that can be used. More...

std::vector< Point >	interpolation_points
	The list of interpolation points, i.e. More...

std::vector< unsigned int >	interpolation_points_var
	The corresponding list of variables indices at which the interpolation points were identified. More...

std::vector< Elem * >	interpolation_points_elem
	The corresponding list of elements at which the interpolation points were identified. More...

std::vector< std::unique_ptr< NumericVector< Number > > >	basis_functions
	The libMesh vectors storing the finite element coefficients of the RB basis functions. More...

std::vector< RBParameters >	greedy_param_list
	The list of parameters selected by the Greedy algorithm in generating the Reduced Basis associated with this RBEvaluation object. More...

DenseMatrix< Number >	RB_inner_product_matrix
	The inner product matrix. More...

std::vector< DenseMatrix< Number > >	RB_Aq_vector
	Dense matrices for the RB computations. More...

std::vector< DenseVector< Number > >	RB_Fq_vector
	Dense vector for the RHS. More...

DenseVector< Number >	RB_solution
	The RB solution vector. More...

std::vector< std::vector< DenseVector< Number > > >	RB_output_vectors
	The vectors storing the RB output vectors. More...

std::vector< Number >	RB_outputs
	The vectors storing the RB output values and corresponding error bounds. More...

std::vector< Real >	RB_output_error_bounds

std::vector< Number >	Fq_representor_innerprods
	Vectors storing the residual representor inner products to be used in computing the residuals online. More...

std::vector< std::vector< std::vector< Number > > >	Fq_Aq_representor_innerprods
	Vectors storing the residual representor inner products to be used in computing the residuals online. More...

std::vector< std::vector< std::vector< Number > > >	Aq_Aq_representor_innerprods

std::vector< std::vector< Number > >	output_dual_innerprods
	The vector storing the dual norm inner product terms for each output. More...

std::vector< std::vector< std::unique_ptr< NumericVector< Number > > > >	Aq_representor
	Vector storing the residual representors associated with the left-hand side. More...

bool	evaluate_RB_error_bound
	Boolean to indicate whether we evaluate a posteriori error bounds when rb_solve is called. More...

bool	compute_RB_inner_product
	Boolean flag to indicate whether we compute the RB_inner_product_matrix. More...

bool	verbose_mode
	Public boolean to toggle verbose mode. More...

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. More...

Protected Member Functions
void	assert_file_exists (const std::string &file_name)
	Helper function that checks if `file_name` exists. More...

void	increment_constructor_count (const std::string &name)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	Increments the destruction counter. More...

Protected Attributes
const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. More...

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting. More...

static bool	_enable_print_counter
	Flag to control whether reference count information is printed when print_info is called. More...

Private Member Functions
void	legacy_write_out_interpolation_points_elem (const std::string &directory_name)
	Write out interpolation_points_elem by putting the elements into a mesh and writing out the mesh. More...

void	legacy_read_in_interpolation_points_elem (const std::string &directory_name)
	Read int interpolation_points_elem from a mesh. More...

Private Attributes
std::vector< RBParametrizedFunction * >	_parametrized_functions
	This vector stores the parametrized functions that will be approximated in this EIM system. More...

std::vector< std::unique_ptr< RBTheta > >	_rb_eim_theta_objects
	The vector of RBTheta objects that are created to point to this RBEIMEvaluation. More...

RBThetaExpansion	_empty_rb_theta_expansion
	We initialize RBEIMEvaluation so that it has an "empty" RBThetaExpansion, because this isn't used at all in the EIM. More...

RBParameters	_previous_parameters
	Store the parameters at which the previous solve was performed (so we can avoid an unnecessary repeat solve). More...

unsigned int	_previous_N
	Store the number of basis functions used for the previous solve (so we can avoid an unnecessary repeat solve). More...

Real	_previous_error_bound
	Store the previous error bound returned by rb_solve (so we can return it if we are avoiding an unnecessary repeat solve). More...

ReplicatedMesh	_interpolation_points_mesh
	Mesh object that we use to store copies of the elements associated with interpolation points. More...

Detailed Description

This class is part of the rbOOmit framework.

RBEIMEvaluation extends RBEvaluation to encapsulate the code and data required to perform "online" evaluations for EIM approximations.

Author: David J. Knezevic

Date: 2011

Definition at line 52 of file rb_eim_evaluation.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.

◆ Parent

typedef RBEvaluation libMesh::RBEIMEvaluation::Parent

The type of the parent.

Definition at line 69 of file rb_eim_evaluation.h.

Constructor & Destructor Documentation

◆ RBEIMEvaluation()

libMesh::RBEIMEvaluation::RBEIMEvaluation ( const libMesh::Parallel::Communicator & comm_in )

Constructor.

◆ ~RBEIMEvaluation()

virtual libMesh::RBEIMEvaluation::~RBEIMEvaluation ( )

virtual

Destructor.

Member Function Documentation

◆ assert_file_exists()

void libMesh::RBEvaluation::assert_file_exists ( const std::string & file_name )

protectedinherited

Helper function that checks if file_name exists.

◆ attach_parametrized_function()

void libMesh::RBEIMEvaluation::attach_parametrized_function ( RBParametrizedFunction * pf )

Attach the parametrized function that we will approximate using the Empirical Interpolation Method.

◆ build_eim_theta()

virtual std::unique_ptr<RBTheta> libMesh::RBEIMEvaluation::build_eim_theta ( unsigned int index )

virtual

Build a theta object corresponding to EIM index index.

The default implementation builds an RBEIMTheta object, possibly override in subclasses if we need more specialized behavior.

◆ clear()

virtual void libMesh::RBEIMEvaluation::clear ( )

overridevirtual

Clear this object.

Reimplemented from libMesh::RBEvaluation.

◆ clear_riesz_representors()

virtual void libMesh::RBEvaluation::clear_riesz_representors ( )

virtualinherited

Clear all the Riesz representors that are used to compute the RB residual (and hence error bound).

This is useful since once we complete the Greedy we may not need the representors any more.

Reimplemented in libMesh::TransientRBEvaluation.

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 87 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id(), and libMesh::Parallel::sync_node_data_by_element_id_once().

88 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:105

◆ compute_residual_dual_norm()

virtual Real libMesh::RBEvaluation::compute_residual_dual_norm ( const unsigned int N )

virtualinherited

Compute the dual norm of the residual for the solution saved in RB_solution_vector.

Reimplemented in libMesh::TransientRBEvaluation.

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ eval_output_dual_norm()

Real libMesh::RBEvaluation::eval_output_dual_norm	(	unsigned int	n,
		const RBParameters &	mu
	)

inherited

Evaluate the dual norm of output n for the current parameters.

◆ evaluate_parametrized_function()

Number libMesh::RBEIMEvaluation::evaluate_parametrized_function	(	unsigned int	var_index,
		const Point &	p,
		const Elem &	elem
	)

Returns: The value of the parametrized function that is being approximated at the point p. var_index specifies the variable (i.e. the parametrized function index) to be evaluated. elem specifies the element of the mesh that contains p.

◆ get_basis_function()

NumericVector<Number>& libMesh::RBEvaluation::get_basis_function ( unsigned int i )

inherited

Get a reference to the i^th basis function.

◆ get_closest_value()

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

staticinherited

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

inherited

Get a const reference to the discrete parameter values.

◆ get_eim_theta_objects()

std::vector<std::unique_ptr<RBTheta> >& libMesh::RBEIMEvaluation::get_eim_theta_objects ( )

Returns: The vector of theta objects that point to this RBEIMEvaluation.

◆ get_error_bound_normalization()

virtual Real libMesh::RBEIMEvaluation::get_error_bound_normalization ( )

overridevirtual

Returns: A scaling factor that we can use to provide a consistent scaling of the RB error bound across different parameter values.

Reimplemented from libMesh::RBEvaluation.

◆ get_info()

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

staticinherited

Gets a string containing the reference information.

◆ get_interpolation_points_mesh()

ReplicatedMesh& libMesh::RBEIMEvaluation::get_interpolation_points_mesh ( )

Get a writable reference to the interpolation points mesh.

◆ get_n_basis_functions()

virtual unsigned int libMesh::RBEvaluation::get_n_basis_functions ( ) const

virtualinherited

Get the current number of basis functions.

Definition at line 146 of file rb_evaluation.h.

References libMesh::RBEvaluation::basis_functions.

147 { return cast_int<unsigned int>(basis_functions.size()); }

libMesh::RBEvaluation::basis_functions

std::vector< std::unique_ptr< NumericVector< Number > > > basis_functions

The libMesh vectors storing the finite element coefficients of the RB basis functions.

Definition: rb_evaluation.h:242

◆ get_n_continuous_params()

unsigned int libMesh::RBParametrized::get_n_continuous_params ( ) const

inherited

Get the number of continuous parameters.

◆ get_n_discrete_params()

unsigned int libMesh::RBParametrized::get_n_discrete_params ( ) const

inherited

Get the number of discrete parameters.

◆ get_n_parametrized_functions()

unsigned int libMesh::RBEIMEvaluation::get_n_parametrized_functions ( ) const

Get the number of parametrized functions that have been attached to this system.

◆ get_n_params()

unsigned int libMesh::RBParametrized::get_n_params ( ) const

inherited

Get the number of parameters.

◆ get_parameter_max()

Real libMesh::RBParametrized::get_parameter_max ( const std::string & param_name ) const

inherited

Get maximum allowable value of parameter param_name.

◆ get_parameter_min()

Real libMesh::RBParametrized::get_parameter_min ( const std::string & param_name ) const

inherited

Get minimum allowable value of parameter param_name.

◆ get_parameter_names()

std::set<std::string> libMesh::RBParametrized::get_parameter_names ( ) const

inherited

Get a set that stores the parameter names.

◆ get_parameters()

const RBParameters& libMesh::RBParametrized::get_parameters ( ) const

inherited

Get the current parameters.

Referenced by SimpleRBEvaluation::get_stability_lower_bound().

◆ get_parameters_max()

const RBParameters& libMesh::RBParametrized::get_parameters_max ( ) const

inherited

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

◆ get_parameters_min()

const RBParameters& libMesh::RBParametrized::get_parameters_min ( ) const

inherited

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

◆ get_rb_theta_expansion()

RBThetaExpansion& libMesh::RBEvaluation::get_rb_theta_expansion ( )

inherited

Get a reference to the rb_theta_expansion.

◆ get_stability_lower_bound()

virtual Real libMesh::RBEvaluation::get_stability_lower_bound ( )

virtualinherited

Get a lower bound for the stability constant (e.g.

coercivity constant or inf-sup constant) at the current parameter value.

Reimplemented in SimpleRBEvaluation, SimpleRBEvaluation, SimpleRBEvaluation, SimpleRBEvaluation, SimpleRBEvaluation, and ElasticityRBEvaluation.

◆ increment_constructor_count()

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

protectedinherited

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 )

protectedinherited

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_eim_theta_objects()

void libMesh::RBEIMEvaluation::initialize_eim_theta_objects ( )

Build a vector of RBTheta objects that accesses the components of the RB_solution member variable of this RBEvaluation.

Store these objects in the member vector rb_theta_objects.

◆ 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
	)

inherited

Initialize the parameter ranges and set current_parameters.

◆ initialize_parameters() [2/2]

void libMesh::RBParametrized::initialize_parameters ( const RBParametrized & rb_parametrized )

inherited

Initialize the parameter ranges and set current_parameters.

◆ is_discrete_parameter()

bool libMesh::RBParametrized::is_discrete_parameter ( const std::string & mu_name ) const

inherited

Is parameter mu_name discrete?

◆ is_rb_theta_expansion_initialized()

bool libMesh::RBEvaluation::is_rb_theta_expansion_initialized ( ) const

inherited

Returns: true if the theta expansion has been initialized.

◆ legacy_read_in_interpolation_points_elem()

void libMesh::RBEIMEvaluation::legacy_read_in_interpolation_points_elem ( const std::string & directory_name )

private

Read int interpolation_points_elem from a mesh.

◆ legacy_read_offline_data_from_files()

virtual void libMesh::RBEIMEvaluation::legacy_read_offline_data_from_files	(	const std::string &	directory_name = `"offline_data"`,
		bool	read_error_bound_data = `true`,
		const bool	read_binary_data = `true`
	)

overridevirtual

Read in the saved Offline reduced basis data to initialize the system for Online solves.

Note: This is a legacy method, use RBDataSerialization instead.

Reimplemented from libMesh::RBEvaluation.

◆ legacy_write_offline_data_to_files()

virtual void libMesh::RBEIMEvaluation::legacy_write_offline_data_to_files	(	const std::string &	directory_name = `"offline_data"`,
		const bool	write_binary_data = `true`
	)

overridevirtual

Write out all the data to text files in order to segregate the Offline stage from the Online stage.

Note: This is a legacy method, use RBDataSerialization instead.

Reimplemented from libMesh::RBEvaluation.

◆ legacy_write_out_interpolation_points_elem()

void libMesh::RBEIMEvaluation::legacy_write_out_interpolation_points_elem ( const std::string & directory_name )

private

Write out interpolation_points_elem by putting the elements into a mesh and writing out the mesh.

◆ n_objects()

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

staticinherited

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.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inherited

Returns: The number of processors in the group.

Definition at line 93 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

Referenced by libMesh::MeshBase::partition().

94 { return cast_int<processor_id_type>(_communicator.size()); }

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:105

◆ print_discrete_parameter_values()

void libMesh::RBParametrized::print_discrete_parameter_values ( ) const

inherited

Print out all the discrete parameter values.

◆ print_info()

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

staticinherited

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

◆ print_parameters()

void libMesh::RBParametrized::print_parameters ( ) const

inherited

Print the current parameters.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns: The rank of this processor in the group.

Definition at line 99 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

Referenced by libMesh::DofMap::end_dof(), libMesh::DofMap::end_old_dof(), libMesh::DofMap::first_dof(), libMesh::DofMap::first_old_dof(), libMesh::DofMap::last_dof(), libMesh::MeshBase::n_active_local_elem(), libMesh::DofMap::n_local_dofs(), libMesh::MeshBase::n_local_elem(), libMesh::MeshBase::n_local_nodes(), and libMesh::MeshTools::weight().

100 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:105

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ rb_solve() [1/2]

virtual Real libMesh::RBEIMEvaluation::rb_solve ( unsigned int N )

overridevirtual

Calculate the EIM approximation to parametrized_function using the first N EIM basis functions.

Store the solution coefficients in the member RB_solution.

Returns: The EIM a posteriori error bound.

Reimplemented from libMesh::RBEvaluation.

◆ rb_solve() [2/2]

void libMesh::RBEIMEvaluation::rb_solve ( DenseVector< Number > & EIM_rhs )

Calculate the EIM approximation for the given right-hand side vector EIM_rhs.

Store the solution coefficients in the member RB_solution.

◆ read_in_basis_functions()

virtual void libMesh::RBEvaluation::read_in_basis_functions	(	System &	sys,
		const std::string &	directory_name = `"offline_data"`,
		const bool	read_binary_basis_functions = `true`
	)

virtualinherited

Read in all the basis functions from file.

Parameters

sys	Used for file IO.
directory_name	Specifies which directory to write files to.
read_binary_basis_functions	Indicates whether to expect binary or ASCII data.

◆ read_in_vectors()

void libMesh::RBEvaluation::read_in_vectors	(	System &	sys,
		std::vector< std::unique_ptr< NumericVector< Number >>> &	vectors,
		const std::string &	directory_name,
		const std::string &	data_name,
		const bool	read_binary_vectors
	)

inherited

Same as read_in_basis_functions, except in this case we pass in the vectors to be written.

We assume that the size of vectors indicates the number of vectors that need to be read in.

◆ read_in_vectors_from_multiple_files()

void libMesh::RBEvaluation::read_in_vectors_from_multiple_files	(	System &	sys,
		std::vector< std::vector< std::unique_ptr< NumericVector< Number >>> *>	multiple_vectors,
		const std::vector< std::string > &	multiple_directory_names,
		const std::vector< std::string > &	multiple_data_names,
		const bool	read_binary_vectors
	)

inherited

Performs read_in_vectors for a list of directory names and data names.

Reading in vectors requires us to renumber the dofs in a partition-independent way. This function only renumbers the dofs once at the start (and reverts it at the end), which can save a lot of work compared to renumbering on every read.

◆ 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
	)

inherited

Read in the parameter ranges from files.

◆ residual_scaling_denom()

virtual Real libMesh::RBEvaluation::residual_scaling_denom ( Real alpha_LB )

virtualinherited

Specifies the residual scaling on the denominator to be used in the a posteriori error bound.

Override in subclass in order to obtain the desired error bound.

◆ resize_data_structures()

virtual void libMesh::RBEIMEvaluation::resize_data_structures	(	const unsigned int	Nmax,
		bool	resize_error_bound_data = `true`
	)

overridevirtual

Resize the data structures for storing data associated with this object.

Reimplemented from libMesh::RBEvaluation.

◆ set_n_basis_functions()

virtual void libMesh::RBEvaluation::set_n_basis_functions ( unsigned int n_bfs )

virtualinherited

Set the number of basis functions.

Useful when reading in stored data.

◆ set_parameters()

void libMesh::RBParametrized::set_parameters ( const RBParameters & params )

inherited

Set the current parameters to params.

Referenced by SimpleRBEvaluation::get_stability_lower_bound().

◆ set_rb_theta_expansion()

void libMesh::RBEvaluation::set_rb_theta_expansion ( RBThetaExpansion & rb_theta_expansion_in )

inherited

Set the RBThetaExpansion object.

Referenced by SimpleRBEvaluation::SimpleRBEvaluation().

◆ write_out_basis_functions()

virtual void libMesh::RBEvaluation::write_out_basis_functions	(	System &	sys,
		const std::string &	directory_name = `"offline_data"`,
		const bool	write_binary_basis_functions = `true`
	)

virtualinherited

Write out all the basis functions to file.

sys is used for file IO directory_name specifies which directory to write files to read_binary_basis_functions indicates whether to expect binary or ASCII data

◆ write_out_vectors()

virtual void libMesh::RBEvaluation::write_out_vectors	(	System &	sys,
		std::vector< NumericVector< Number > *> &	vectors,
		const std::string &	directory_name = `"offline_data"`,
		const std::string &	data_name = `"bf"`,
		const bool	write_binary_basis_functions = `true`
	)

virtualinherited

Same as write_out_basis_functions, except in this case we pass in the vectors to be written.

◆ 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
	)

inherited

Write out the parameter ranges to files.

Member Data Documentation

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 105 of file parallel_object.h.

Referenced by libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

◆ _counts

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _empty_rb_theta_expansion

RBThetaExpansion libMesh::RBEIMEvaluation::_empty_rb_theta_expansion

private

We initialize RBEIMEvaluation so that it has an "empty" RBThetaExpansion, because this isn't used at all in the EIM.

Definition at line 226 of file rb_eim_evaluation.h.

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter

staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

◆ _interpolation_points_mesh

ReplicatedMesh libMesh::RBEIMEvaluation::_interpolation_points_mesh

private

Mesh object that we use to store copies of the elements associated with interpolation points.

Definition at line 250 of file rb_eim_evaluation.h.

◆ _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().

◆ _parametrized_functions

std::vector<RBParametrizedFunction *> libMesh::RBEIMEvaluation::_parametrized_functions

private

This vector stores the parametrized functions that will be approximated in this EIM system.

Definition at line 214 of file rb_eim_evaluation.h.

◆ _previous_error_bound

Real libMesh::RBEIMEvaluation::_previous_error_bound

private

Store the previous error bound returned by rb_solve (so we can return it if we are avoiding an unnecessary repeat solve).

Definition at line 244 of file rb_eim_evaluation.h.

◆ _previous_N

unsigned int libMesh::RBEIMEvaluation::_previous_N

private

Store the number of basis functions used for the previous solve (so we can avoid an unnecessary repeat solve).

Definition at line 238 of file rb_eim_evaluation.h.

◆ _previous_parameters

RBParameters libMesh::RBEIMEvaluation::_previous_parameters

private

Store the parameters at which the previous solve was performed (so we can avoid an unnecessary repeat solve).

Definition at line 232 of file rb_eim_evaluation.h.

◆ _rb_eim_theta_objects

std::vector<std::unique_ptr<RBTheta> > libMesh::RBEIMEvaluation::_rb_eim_theta_objects

private

The vector of RBTheta objects that are created to point to this RBEIMEvaluation.

Definition at line 220 of file rb_eim_evaluation.h.

◆ Aq_Aq_representor_innerprods

std::vector<std::vector<std::vector<Number> > > libMesh::RBEvaluation::Aq_Aq_representor_innerprods

inherited

Definition at line 301 of file rb_evaluation.h.

◆ Aq_representor

std::vector<std::vector<std::unique_ptr<NumericVector<Number> > > > libMesh::RBEvaluation::Aq_representor

inherited

Vector storing the residual representors associated with the left-hand side.

These are basis dependent and hence stored here, whereas the Fq_representors are stored in RBSystem.

Definition at line 317 of file rb_evaluation.h.

◆ basis_functions

std::vector<std::unique_ptr<NumericVector<Number> > > libMesh::RBEvaluation::basis_functions

inherited

The libMesh vectors storing the finite element coefficients of the RB basis functions.

Definition at line 242 of file rb_evaluation.h.

Referenced by libMesh::RBEvaluation::get_n_basis_functions().

◆ compute_RB_inner_product

bool libMesh::RBEvaluation::compute_RB_inner_product

inherited

Boolean flag to indicate whether we compute the RB_inner_product_matrix.

Definition at line 328 of file rb_evaluation.h.

◆ evaluate_RB_error_bound

bool libMesh::RBEvaluation::evaluate_RB_error_bound

inherited

Boolean to indicate whether we evaluate a posteriori error bounds when rb_solve is called.

Definition at line 323 of file rb_evaluation.h.

◆ Fq_Aq_representor_innerprods

std::vector<std::vector<std::vector<Number> > > libMesh::RBEvaluation::Fq_Aq_representor_innerprods

inherited

Vectors storing the residual representor inner products to be used in computing the residuals online.

We store the Aq-dependent representor inner products because they depend on a reduced basis space. The basis independent representors are stored in RBSystem.

Definition at line 300 of file rb_evaluation.h.

◆ Fq_representor_innerprods

std::vector<Number> libMesh::RBEvaluation::Fq_representor_innerprods

inherited

Vectors storing the residual representor inner products to be used in computing the residuals online.

These values are independent of a basis, hence they can be copied over directly from an RBSystem.

Definition at line 291 of file rb_evaluation.h.

◆ greedy_param_list

std::vector<RBParameters> libMesh::RBEvaluation::greedy_param_list

inherited

The list of parameters selected by the Greedy algorithm in generating the Reduced Basis associated with this RBEvaluation object.

Definition at line 248 of file rb_evaluation.h.

◆ interpolation_matrix

DenseMatrix<Number> libMesh::RBEIMEvaluation::interpolation_matrix

Dense matrix that stores the lower triangular interpolation matrix that can be used.

Definition at line 177 of file rb_eim_evaluation.h.

◆ interpolation_points

std::vector<Point> libMesh::RBEIMEvaluation::interpolation_points

The list of interpolation points, i.e.

locations at which the basis functions are maximized.

Definition at line 183 of file rb_eim_evaluation.h.

◆ interpolation_points_elem

std::vector<Elem *> libMesh::RBEIMEvaluation::interpolation_points_elem

The corresponding list of elements at which the interpolation points were identified.

Definition at line 195 of file rb_eim_evaluation.h.

◆ interpolation_points_var

std::vector<unsigned int> libMesh::RBEIMEvaluation::interpolation_points_var

The corresponding list of variables indices at which the interpolation points were identified.

Definition at line 189 of file rb_eim_evaluation.h.

◆ output_dual_innerprods

std::vector<std::vector<Number > > libMesh::RBEvaluation::output_dual_innerprods

inherited

The vector storing the dual norm inner product terms for each output.

These values are independent of a basis, hence they can be copied over directly from an RBSystem.

Definition at line 309 of file rb_evaluation.h.

◆ RB_Aq_vector

std::vector<DenseMatrix<Number> > libMesh::RBEvaluation::RB_Aq_vector

inherited

Dense matrices for the RB computations.

Definition at line 261 of file rb_evaluation.h.

◆ RB_Fq_vector

std::vector<DenseVector<Number> > libMesh::RBEvaluation::RB_Fq_vector

inherited

Dense vector for the RHS.

Definition at line 266 of file rb_evaluation.h.

◆ RB_inner_product_matrix

DenseMatrix<Number> libMesh::RBEvaluation::RB_inner_product_matrix

inherited

The inner product matrix.

This should be close to the identity, we need to calculate this rather than assume diagonality in order to accurately perform projections since orthogonality degrades with increasing N.

Definition at line 256 of file rb_evaluation.h.

◆ RB_output_error_bounds

std::vector<Real > libMesh::RBEvaluation::RB_output_error_bounds

inherited

Definition at line 283 of file rb_evaluation.h.

◆ RB_output_vectors

std::vector<std::vector<DenseVector<Number> > > libMesh::RBEvaluation::RB_output_vectors

inherited

The vectors storing the RB output vectors.

Definition at line 276 of file rb_evaluation.h.

◆ RB_outputs

std::vector<Number > libMesh::RBEvaluation::RB_outputs

inherited

The vectors storing the RB output values and corresponding error bounds.

Definition at line 282 of file rb_evaluation.h.

◆ RB_solution

DenseVector<Number> libMesh::RBEvaluation::RB_solution

inherited

The RB solution vector.

Definition at line 271 of file rb_evaluation.h.

◆ verbose_mode

bool libMesh::RBParametrized::verbose_mode

inherited

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:

include/reduced_basis/rb_eim_evaluation.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

◆ Parent

Constructor & Destructor Documentation

◆ RBEIMEvaluation()

◆ ~RBEIMEvaluation()

Member Function Documentation

◆ assert_file_exists()

◆ attach_parametrized_function()

◆ build_eim_theta()

◆ clear()

◆ clear_riesz_representors()

◆ comm()

◆ compute_residual_dual_norm()

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ eval_output_dual_norm()

◆ evaluate_parametrized_function()

◆ get_basis_function()

◆ get_closest_value()

◆ get_discrete_parameter_values()

◆ get_eim_theta_objects()

◆ get_error_bound_normalization()

◆ get_info()

◆ get_interpolation_points_mesh()

◆ get_n_basis_functions()

◆ get_n_continuous_params()

◆ get_n_discrete_params()

◆ get_n_parametrized_functions()

◆ get_n_params()

◆ get_parameter_max()

◆ get_parameter_min()

◆ get_parameter_names()

◆ get_parameters()

◆ get_parameters_max()

◆ get_parameters_min()

◆ get_rb_theta_expansion()

◆ get_stability_lower_bound()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ initialize_eim_theta_objects()

◆ initialize_parameters() [1/2]

◆ initialize_parameters() [2/2]

◆ is_discrete_parameter()

◆ is_rb_theta_expansion_initialized()

◆ legacy_read_in_interpolation_points_elem()

◆ legacy_read_offline_data_from_files()

◆ legacy_write_offline_data_to_files()

◆ legacy_write_out_interpolation_points_elem()

◆ n_objects()

◆ n_processors()

◆ print_discrete_parameter_values()

◆ print_info()

◆ print_parameters()

◆ processor_id()

◆ rb_solve() [1/2]

◆ rb_solve() [2/2]

◆ read_in_basis_functions()

◆ read_in_vectors()

◆ read_in_vectors_from_multiple_files()

◆ read_parameter_data_from_files()

◆ residual_scaling_denom()

◆ resize_data_structures()

◆ set_n_basis_functions()

◆ set_parameters()

◆ set_rb_theta_expansion()

◆ write_out_basis_functions()

◆ write_out_vectors()

◆ write_parameter_data_to_files()