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

#include <rb_scm_construction.h>

Inheritance diagram for libMesh::RBSCMConstruction:

Public Types
typedef RBSCMConstruction	sys_type
	The type of system. More...

typedef RBConstructionBase< CondensedEigenSystem >	Parent
	The type of the parent. More...

typedef Number(*	ValueFunctionPointer) (const Point &p, const Parameters &Parameters, const std::string &sys_name, const std::string &unknown_name)
	Projects arbitrary functions onto the current solution. More...

typedef Gradient(*	GradientFunctionPointer) (const Point &p, const Parameters &parameters, const std::string &sys_name, const std::string &unknown_name)

typedef std::map< std::string, NumericVector< Number > * >::iterator	vectors_iterator
	Vector iterator typedefs. More...

typedef std::map< std::string, NumericVector< Number > * >::const_iterator	const_vectors_iterator

Public Member Functions
	RBSCMConstruction (EquationSystems &es, const std::string &name_in, const unsigned int number_in)
	Constructor. More...

virtual	~RBSCMConstruction ()
	Destructor. More...

virtual void	clear () override
	Clear all the data structures associated with the system. More...

void	set_rb_scm_evaluation (RBSCMEvaluation &rb_scm_eval_in)
	Set the RBSCMEvaluation object. More...

RBSCMEvaluation &	get_rb_scm_evaluation ()
	Get a reference to the RBSCMEvaluation object. More...

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

virtual void	resize_SCM_vectors ()
	Clear and resize the SCM data vectors. More...

virtual void	process_parameters_file (const std::string &parameters_filename)
	Read in the parameters from file specified by `parameters_filename` and set the this system's member variables accordingly. More...

virtual void	print_info ()
	Print out info that describes the current setup of this RBSCMConstruction. More...

virtual void	set_eigensolver_properties (int)
	This function is called before truth eigensolves in compute_SCM_bounding_box and evaluate_stability_constant. More...

void	set_RB_system_name (const std::string &new_name)
	Set the name of the associated RB system — we need this to load the (symmetrized) affine operators. More...

Real	get_SCM_training_tolerance () const
	Get/set SCM_training_tolerance: tolerance for SCM greedy. More...

void	set_SCM_training_tolerance (Real SCM_training_tolerance_in)

virtual void	perform_SCM_greedy ()
	Perform the SCM greedy algorithm to develop a lower bound over the training set. More...

virtual void	attach_deflation_space ()
	Attach the deflation space defined by the specified vector, can be useful in solving constrained eigenvalue problems. More...

sys_type &	system ()

void	set_quiet_mode (bool quiet_mode_in)
	Set the quiet_mode flag. More...

bool	is_quiet () const
	Is the system in quiet mode? More...

numeric_index_type	get_n_training_samples () const
	Get the total number of training samples. More...

numeric_index_type	get_local_n_training_samples () const
	Get the total number of training samples local to this processor. More...

numeric_index_type	get_first_local_training_index () const
	Get the first local index of the training parameters. More...

numeric_index_type	get_last_local_training_index () const
	Get the last local index of the training parameters. More...

virtual void	initialize_training_parameters (const RBParameters &mu_min, const RBParameters &mu_max, unsigned int n_training_parameters, std::map< std::string, bool > log_param_scale, bool deterministic=true)
	Initialize the parameter ranges and indicate whether deterministic or random training parameters should be used and whether or not we want the parameters to be scaled logarithmically. More...

virtual void	load_training_set (std::map< std::string, std::vector< Number >> &new_training_set)
	Overwrite the training parameters with new_training_set. More...

void	broadcast_parameters (unsigned int proc_id)
	Broadcasts parameters on processor proc_id to all processors. More...

void	set_training_random_seed (unsigned int seed)
	Set the seed that is used to randomly generate training parameters. More...

void	set_deterministic_training_parameter_name (const std::string &name)
	In some cases we only want to allow discrete parameter values, instead of parameters that may take any value in a specified interval. More...

const std::string &	get_deterministic_training_parameter_name () const
	Get the name of the parameter that we will generate deterministic training parameters for. More...

void	set_deterministic_training_parameter_repeats (unsigned int repeats)
	Set the number of times each sample of the deterministic training parameter is repeated. More...

unsigned int	get_deterministic_training_parameter_repeats () const
	Get the number of times each sample of the deterministic training parameter is repeated. More...

void	initialize_condensed_dofs (const std::set< dof_id_type > &global_condensed_dofs_set=std::set< dof_id_type >())
	Loop over the dofs on each processor to initialize the list of non-condensed dofs. More...

dof_id_type	n_global_non_condensed_dofs () const

virtual void	solve () override
	Override to solve the condensed eigenproblem with the dofs in local_non_condensed_dofs_vector stripped out of the system matrices on each processor. More...

virtual std::pair< Real, Real >	get_eigenpair (dof_id_type i) override
	Override `get_eigenpair()` to retrieve the eigenpair for the condensed eigensolve. More...

virtual void	reinit () override
	Reinitializes the member data fields associated with the system, so that, e.g., `assemble()` may be used. More...

virtual void	assemble () override
	Assembles the system matrix. More...

virtual std::string	system_type () const override

virtual unsigned int	n_matrices () const override

unsigned int	get_n_converged () const

unsigned int	get_n_iterations () const

void	set_eigenproblem_type (EigenProblemType ept)
	Sets the type of the current eigen problem. More...

EigenProblemType	get_eigenproblem_type () const

bool	generalized () const

void	init ()
	Initializes degrees of freedom on the current mesh. More...

virtual void	reinit_constraints ()
	Reinitializes the constraints for this system. More...

bool	is_initialized ()

virtual void	update ()
	Update the local values to reflect the solution on neighboring processors. More...

virtual void	assemble_qoi (const QoISet &qoi_indices=QoISet())
	Calls user qoi function. More...

virtual void	assemble_qoi_derivative (const QoISet &qoi_indices=QoISet(), bool include_liftfunc=true, bool apply_constraints=true)
	Calls user qoi derivative function. More...

virtual void	assemble_residual_derivatives (const ParameterVector &parameters)
	Calls residual parameter derivative function. More...

virtual void	restrict_solve_to (const SystemSubset *subset, const SubsetSolveMode subset_solve_mode=SUBSET_ZERO)
	After calling this method, any solve will be restricted to the given subdomain. More...

virtual std::pair< unsigned int, Real >	sensitivity_solve (const ParameterVector &parameters)
	Solves the sensitivity system, for the provided parameters. More...

virtual std::pair< unsigned int, Real >	weighted_sensitivity_solve (const ParameterVector &parameters, const ParameterVector &weights)
	Assembles & solves the linear system(s) (dR/du)u_w = sum(w_p-dR/dp), for those parameters p contained within `parameters` weighted by the values w_p found within `weights`. More...

virtual std::pair< unsigned int, Real >	adjoint_solve (const QoISet &qoi_indices=QoISet())
	Solves the adjoint system, for the specified qoi indices, or for every qoi if `qoi_indices` is nullptr. More...

virtual std::pair< unsigned int, Real >	weighted_sensitivity_adjoint_solve (const ParameterVector &parameters, const ParameterVector &weights, const QoISet &qoi_indices=QoISet())
	Assembles & solves the linear system(s) (dR/du)^Tz_w = sum(w_p(d^2q/dudp - d^2R/dudp*z)), for those parameters p contained within `parameters`, weighted by the values w_p found within `weights`. More...

bool	is_adjoint_already_solved () const
	Accessor for the adjoint_already_solved boolean. More...

void	set_adjoint_already_solved (bool setting)
	Setter for the adjoint_already_solved boolean. More...

virtual void	qoi_parameter_sensitivity (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &sensitivities)
	Solves for the derivative of each of the system's quantities of interest q in `qoi`[qoi_indices] with respect to each parameter in `parameters`, placing the result for qoi `i` and parameter `j` into `sensitivities`[i][j]. More...

virtual void	adjoint_qoi_parameter_sensitivity (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &sensitivities)
	Solves for parameter sensitivities using the adjoint method. More...

virtual void	forward_qoi_parameter_sensitivity (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &sensitivities)
	Solves for parameter sensitivities using the forward method. More...

virtual void	qoi_parameter_hessian (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &hessian)
	For each of the system's quantities of interest q in `qoi`[qoi_indices], and for a vector of parameters p, the parameter sensitivity Hessian H_ij is defined as H_ij = (d^2 q)/(d p_i d p_j) This Hessian is the output of this method, where for each q_i, H_jk is stored in `hessian.second_derivative(i,j,k)`. More...

virtual void	qoi_parameter_hessian_vector_product (const QoISet &qoi_indices, const ParameterVector &parameters, const ParameterVector &vector, SensitivityData &product)
	For each of the system's quantities of interest q in `qoi`[qoi_indices], and for a vector of parameters p, the parameter sensitivity Hessian H_ij is defined as H_ij = (d^2 q)/(d p_i d p_j) The Hessian-vector product, for a vector v_k in parameter space, is S_j = H_jk v_k This product is the output of this method, where for each q_i, S_j is stored in `sensitivities`[i][j]. More...

virtual bool	compare (const System &other_system, const Real threshold, const bool verbose) const

const std::string &	name () const

void	project_solution (FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr) const
	Projects arbitrary functions onto the current solution. More...

void	project_solution (FEMFunctionBase< Number > f, FEMFunctionBase< Gradient > g=nullptr) const
	Projects arbitrary functions onto the current solution. More...

void	project_solution (ValueFunctionPointer fptr, GradientFunctionPointer gptr, const Parameters &parameters) const

void	project_vector (NumericVector< Number > &new_vector, FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr, int is_adjoint=-1) const
	Projects arbitrary functions onto a vector of degree of freedom values for the current system. More...

void	project_vector (NumericVector< Number > &new_vector, FEMFunctionBase< Number > f, FEMFunctionBase< Gradient > g=nullptr, int is_adjoint=-1) const
	Projects arbitrary functions onto a vector of degree of freedom values for the current system. More...

void	project_vector (ValueFunctionPointer fptr, GradientFunctionPointer gptr, const Parameters &parameters, NumericVector< Number > &new_vector, int is_adjoint=-1) const
	Projects arbitrary functions onto a vector of degree of freedom values for the current system. More...

void	boundary_project_solution (const std::set< boundary_id_type > &b, const std::vector< unsigned int > &variables, FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr)
	Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system. More...

void	boundary_project_solution (const std::set< boundary_id_type > &b, const std::vector< unsigned int > &variables, ValueFunctionPointer fptr, GradientFunctionPointer gptr, const Parameters &parameters)
	Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system. More...

void	boundary_project_vector (const std::set< boundary_id_type > &b, const std::vector< unsigned int > &variables, NumericVector< Number > &new_vector, FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr, int is_adjoint=-1) const
	Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system. More...

void	boundary_project_vector (const std::set< boundary_id_type > &b, const std::vector< unsigned int > &variables, ValueFunctionPointer fptr, GradientFunctionPointer gptr, const Parameters &parameters, NumericVector< Number > &new_vector, int is_adjoint=-1) const
	Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system. More...

unsigned int	number () const

void	update_global_solution (std::vector< Number > &global_soln) const
	Fill the input vector `global_soln` so that it contains the global solution on all processors. More...

void	update_global_solution (std::vector< Number > &global_soln, const processor_id_type dest_proc) const
	Fill the input vector `global_soln` so that it contains the global solution on processor `dest_proc`. More...

const MeshBase &	get_mesh () const

MeshBase &	get_mesh ()

const DofMap &	get_dof_map () const

DofMap &	get_dof_map ()

const EquationSystems &	get_equation_systems () const

EquationSystems &	get_equation_systems ()

bool	active () const

void	activate ()
	Activates the system. More...

void	deactivate ()
	Deactivates the system. More...

void	set_basic_system_only ()
	Sets the system to be "basic only": i.e. More...

vectors_iterator	vectors_begin ()
	Beginning of vectors container. More...

const_vectors_iterator	vectors_begin () const
	Beginning of vectors container. More...

vectors_iterator	vectors_end ()
	End of vectors container. More...

const_vectors_iterator	vectors_end () const
	End of vectors container. More...

NumericVector< Number > &	add_vector (const std::string &vec_name, const bool projections=true, const ParallelType type=PARALLEL)
	Adds the additional vector `vec_name` to this system. More...

void	remove_vector (const std::string &vec_name)
	Removes the additional vector `vec_name` from this system. More...

bool &	project_solution_on_reinit (void)
	Tells the System whether or not to project the solution vector onto new grids when the system is reinitialized. More...

bool	have_vector (const std::string &vec_name) const

const NumericVector< Number > *	request_vector (const std::string &vec_name) const

NumericVector< Number > *	request_vector (const std::string &vec_name)

const NumericVector< Number > *	request_vector (const unsigned int vec_num) const

NumericVector< Number > *	request_vector (const unsigned int vec_num)

const NumericVector< Number > &	get_vector (const std::string &vec_name) const

NumericVector< Number > &	get_vector (const std::string &vec_name)

const NumericVector< Number > &	get_vector (const unsigned int vec_num) const

NumericVector< Number > &	get_vector (const unsigned int vec_num)

const std::string &	vector_name (const unsigned int vec_num) const

const std::string &	vector_name (const NumericVector< Number > &vec_reference) const

void	set_vector_as_adjoint (const std::string &vec_name, int qoi_num)
	Allows one to set the QoI index controlling whether the vector identified by vec_name represents a solution from the adjoint (qoi_num >= 0) or primal (qoi_num == -1) space. More...

int	vector_is_adjoint (const std::string &vec_name) const

void	set_vector_preservation (const std::string &vec_name, bool preserve)
	Allows one to set the boolean controlling whether the vector identified by vec_name should be "preserved": projected to new meshes, saved, etc. More...

bool	vector_preservation (const std::string &vec_name) const

NumericVector< Number > &	add_adjoint_solution (unsigned int i=0)

NumericVector< Number > &	get_adjoint_solution (unsigned int i=0)

const NumericVector< Number > &	get_adjoint_solution (unsigned int i=0) const

NumericVector< Number > &	add_sensitivity_solution (unsigned int i=0)

NumericVector< Number > &	get_sensitivity_solution (unsigned int i=0)

const NumericVector< Number > &	get_sensitivity_solution (unsigned int i=0) const

NumericVector< Number > &	add_weighted_sensitivity_adjoint_solution (unsigned int i=0)

NumericVector< Number > &	get_weighted_sensitivity_adjoint_solution (unsigned int i=0)

const NumericVector< Number > &	get_weighted_sensitivity_adjoint_solution (unsigned int i=0) const

NumericVector< Number > &	add_weighted_sensitivity_solution ()

NumericVector< Number > &	get_weighted_sensitivity_solution ()

const NumericVector< Number > &	get_weighted_sensitivity_solution () const

NumericVector< Number > &	add_adjoint_rhs (unsigned int i=0)

NumericVector< Number > &	get_adjoint_rhs (unsigned int i=0)

const NumericVector< Number > &	get_adjoint_rhs (unsigned int i=0) const

NumericVector< Number > &	add_sensitivity_rhs (unsigned int i=0)

NumericVector< Number > &	get_sensitivity_rhs (unsigned int i=0)

const NumericVector< Number > &	get_sensitivity_rhs (unsigned int i=0) const

unsigned int	n_vectors () const

unsigned int	n_vars () const

unsigned int	n_variable_groups () const

unsigned int	n_components () const

dof_id_type	n_dofs () const

dof_id_type	n_active_dofs () const

dof_id_type	n_constrained_dofs () const

dof_id_type	n_local_constrained_dofs () const

dof_id_type	n_local_dofs () const

unsigned int	add_variable (const std::string &var, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
	Adds the variable `var` to the list of variables for this system. More...

unsigned int	add_variable (const std::string &var, const Order order=FIRST, const FEFamily=LAGRANGE, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
	Adds the variable `var` to the list of variables for this system. More...

unsigned int	add_variables (const std::vector< std::string > &vars, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
	Adds the variable `var` to the list of variables for this system. More...

unsigned int	add_variables (const std::vector< std::string > &vars, const Order order=FIRST, const FEFamily=LAGRANGE, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
	Adds the variable `var` to the list of variables for this system. More...

const Variable &	variable (unsigned int var) const
	Return a constant reference to `Variable` `var`. More...

const VariableGroup &	variable_group (unsigned int vg) const
	Return a constant reference to `VariableGroup` `vg`. More...

bool	has_variable (const std::string &var) const

const std::string &	variable_name (const unsigned int i) const

unsigned short int	variable_number (const std::string &var) const

void	get_all_variable_numbers (std::vector< unsigned int > &all_variable_numbers) const
	Fills `all_variable_numbers` with all the variable numbers for the variables that have been added to this system. More...

unsigned int	variable_scalar_number (const std::string &var, unsigned int component) const

unsigned int	variable_scalar_number (unsigned int var_num, unsigned int component) const

const FEType &	variable_type (const unsigned int i) const

const FEType &	variable_type (const std::string &var) const

bool	identify_variable_groups () const

void	identify_variable_groups (const bool)
	Toggle automatic `VariableGroup` identification. More...

Real	calculate_norm (const NumericVector< Number > &v, unsigned int var, FEMNormType norm_type, std::set< unsigned int > *skip_dimensions=nullptr) const

Real	calculate_norm (const NumericVector< Number > &v, const SystemNorm &norm, std::set< unsigned int > *skip_dimensions=nullptr) const

void	read_header (Xdr &io, const std::string &version, const bool read_header=true, const bool read_additional_data=true, const bool read_legacy_format=false)
	Reads the basic data header for this System. More...

void	read_legacy_data (Xdr &io, const bool read_additional_data=true)
	Reads additional data, namely vectors, for this System. More...

template<typename ValType >
void	read_serialized_data (Xdr &io, const bool read_additional_data=true)
	Reads additional data, namely vectors, for this System. More...

void	read_serialized_data (Xdr &io, const bool read_additional_data=true)
	Non-templated version for backward compatibility. More...

template<typename InValType >
std::size_t	read_serialized_vectors (Xdr &io, const std::vector< NumericVector< Number > *> &vectors) const
	Read a number of identically distributed vectors. More...

std::size_t	read_serialized_vectors (Xdr &io, const std::vector< NumericVector< Number > *> &vectors) const
	Non-templated version for backward compatibility. More...

template<typename InValType >
void	read_parallel_data (Xdr &io, const bool read_additional_data)
	Reads additional data, namely vectors, for this System. More...

void	read_parallel_data (Xdr &io, const bool read_additional_data)
	Non-templated version for backward compatibility. More...

void	write_header (Xdr &io, const std::string &version, const bool write_additional_data) const
	Writes the basic data header for this System. More...

void	write_serialized_data (Xdr &io, const bool write_additional_data=true) const
	Writes additional data, namely vectors, for this System. More...

std::size_t	write_serialized_vectors (Xdr &io, const std::vector< const NumericVector< Number > *> &vectors) const
	Serialize & write a number of identically distributed vectors. More...

void	write_parallel_data (Xdr &io, const bool write_additional_data) const
	Writes additional data, namely vectors, for this System. More...

std::string	get_info () const

void	attach_init_function (void fptr(EquationSystems &es, const std::string &name))
	Register a user function to use in initializing the system. More...

void	attach_init_object (Initialization &init)
	Register a user class to use to initialize the system. More...

void	attach_assemble_function (void fptr(EquationSystems &es, const std::string &name))
	Register a user function to use in assembling the system matrix and RHS. More...

void	attach_assemble_object (Assembly &assemble)
	Register a user object to use in assembling the system matrix and RHS. More...

void	attach_constraint_function (void fptr(EquationSystems &es, const std::string &name))
	Register a user function for imposing constraints. More...

void	attach_constraint_object (Constraint &constrain)
	Register a user object for imposing constraints. More...

void	attach_QOI_function (void fptr(EquationSystems &es, const std::string &name, const QoISet &qoi_indices))
	Register a user function for evaluating the quantities of interest, whose values should be placed in `System::qoi`. More...

void	attach_QOI_object (QOI &qoi)
	Register a user object for evaluating the quantities of interest, whose values should be placed in `System::qoi`. More...

void	attach_QOI_derivative (void fptr(EquationSystems &es, const std::string &name, const QoISet &qoi_indices, bool include_liftfunc, bool apply_constraints))
	Register a user function for evaluating derivatives of a quantity of interest with respect to test functions, whose values should be placed in `System::rhs`. More...

void	attach_QOI_derivative_object (QOIDerivative &qoi_derivative)
	Register a user object for evaluating derivatives of a quantity of interest with respect to test functions, whose values should be placed in `System::rhs`. More...

virtual void	user_initialization ()
	Calls user's attached initialization function, or is overridden by the user in derived classes. More...

virtual void	user_assembly ()
	Calls user's attached assembly function, or is overridden by the user in derived classes. More...

virtual void	user_constrain ()
	Calls user's attached constraint function, or is overridden by the user in derived classes. More...

virtual void	user_QOI (const QoISet &qoi_indices)
	Calls user's attached quantity of interest function, or is overridden by the user in derived classes. More...

virtual void	user_QOI_derivative (const QoISet &qoi_indices=QoISet(), bool include_liftfunc=true, bool apply_constraints=true)
	Calls user's attached quantity of interest derivative function, or is overridden by the user in derived classes. More...

virtual void	re_update ()
	Re-update the local values when the mesh has changed. More...

virtual void	restrict_vectors ()
	Restrict vectors after the mesh has coarsened. More...

virtual void	prolong_vectors ()
	Prolong vectors after the mesh has refined. More...

virtual void	disable_cache ()
	Avoids use of any cached data that might affect any solve result. More...

Number	current_solution (const dof_id_type global_dof_number) const

unsigned int	n_qois () const
	Number of currently active quantities of interest. More...

Number	point_value (unsigned int var, const Point &p, const bool insist_on_success=true) const

Number	point_value (unsigned int var, const Point &p, const Elem &e) const

Number	point_value (unsigned int var, const Point &p, const Elem *e) const
	Calls the version of point_value() which takes a reference. More...

Gradient	point_gradient (unsigned int var, const Point &p, const bool insist_on_success=true) const

Gradient	point_gradient (unsigned int var, const Point &p, const Elem &e) const

Gradient	point_gradient (unsigned int var, const Point &p, const Elem *e) const
	Calls the version of point_gradient() which takes a reference. More...

Tensor	point_hessian (unsigned int var, const Point &p, const bool insist_on_success=true) const

Tensor	point_hessian (unsigned int var, const Point &p, const Elem &e) const

Tensor	point_hessian (unsigned int var, const Point &p, const Elem *e) const
	Calls the version of point_hessian() which takes a reference. More...

void	local_dof_indices (const unsigned int var, std::set< dof_id_type > &var_indices) const
	Fills the std::set with the degrees of freedom on the local processor corresponding the the variable number passed in. More...

void	zero_variable (NumericVector< Number > &v, unsigned int var_num) const
	Zeroes all dofs in `v` that correspond to variable number `var_num`. More...

bool &	hide_output ()

void	projection_matrix (SparseMatrix< Number > &proj_mat) const
	This method creates a projection matrix which corresponds to the operation of project_vector between old and new solution spaces. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

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

Static Public Member Functions
static std::string	get_info ()
	Gets a string containing the reference information. More...

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 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 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	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

static void	disable_print_counter_info ()

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

Public Attributes
std::unique_ptr< SparseMatrix< Number > >	condensed_matrix_A
	The (condensed) system matrix for standard eigenvalue problems. More...

std::unique_ptr< SparseMatrix< Number > >	condensed_matrix_B
	A second (condensed) system matrix for generalized eigenvalue problems. More...

std::vector< dof_id_type >	local_non_condensed_dofs_vector
	Vector storing the local dof indices that will not be condensed. More...

std::unique_ptr< SparseMatrix< Number > >	matrix_A
	The system matrix for standard eigenvalue problems. More...

std::unique_ptr< SparseMatrix< Number > >	matrix_B
	A second system matrix for generalized eigenvalue problems. More...

std::unique_ptr< EigenSolver< Number > >	eigen_solver
	The EigenSolver, defining which interface, i.e solver package to use. More...

bool	assemble_before_solve
	Flag which tells the system to whether or not to call the user assembly function during each call to solve(). More...

bool	use_fixed_solution
	A boolean to be set to true by systems using elem_fixed_solution, for optional use by e.g. More...

int	extra_quadrature_order
	A member int that can be employed to indicate increased or reduced quadrature order. More...

std::unique_ptr< NumericVector< Number > >	solution
	Data structure to hold solution values. More...

std::unique_ptr< NumericVector< Number > >	current_local_solution
	All the values I need to compute my contribution to the simulation at hand. More...

Real	time
	For time-dependent problems, this is the time t at the beginning of the current timestep. More...

std::vector< Number >	qoi
	Values of the quantities of interest. 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...

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

Protected Member Functions
virtual void	add_scaled_symm_Aq (unsigned int q_a, Number scalar)
	Add the scaled symmetrized affine matrix from the associated RBSystem to matrix_A. More...

virtual void	load_matrix_B ()
	Copy over the matrix to store in matrix_B, usually this is the mass or inner-product matrix, but needs to be implemented in subclass. More...

virtual void	compute_SCM_bounding_box ()
	Compute the SCM bounding box. More...

virtual void	evaluate_stability_constant ()
	Compute the stability constant for current_parameters by solving a generalized eigenvalue problem over the truth space. More...

virtual void	enrich_C_J (unsigned int new_C_J_index)
	Enrich C_J by adding the element of SCM_training_samples that has the largest gap between alpha_LB and alpha_LB. More...

virtual std::pair< unsigned int, Real >	compute_SCM_bounds_on_training_set ()
	Compute upper and lower bounds for each SCM training point. More...

Number	B_inner_product (const NumericVector< Number > &v, const NumericVector< Number > &w) const
	Compute the inner product between two vectors using the system's matrix_B. More...

Number	Aq_inner_product (unsigned int q, const NumericVector< Number > &v, const NumericVector< Number > &w)
	Compute the inner product between two vectors using matrix Aq. More...

virtual Real	SCM_greedy_error_indicator (Real LB, Real UB)
	Helper function which provides an error indicator to be used in the SCM greedy. More...

virtual void	init_data ()
	Initializes the member data fields associated with the system, so that, e.g., `assemble()` may be used. More...

RBParameters	get_params_from_training_set (unsigned int index)
	Return the RBParameters in index `index` of training set. More...

void	set_params_from_training_set (unsigned int index)
	Set parameters to the RBParameters stored in index `index` of the training set. More...

virtual void	set_params_from_training_set_and_broadcast (unsigned int index)
	Load the specified training parameter and then broadcast to all processors. More...

virtual void	init_matrices ()
	Initializes the matrices associated with the system. More...

void	set_n_converged (unsigned int nconv)
	Set the _n_converged_eigenpairs member, useful for subclasses of EigenSystem. More...

void	set_n_iterations (unsigned int its)
	Set the _n_iterations member, useful for subclasses of EigenSystem. More...

void	project_vector (NumericVector< Number > &, int is_adjoint=-1) const
	Projects the vector defined on the old mesh onto the new mesh. More...

void	project_vector (const NumericVector< Number > &, NumericVector< Number > &, int is_adjoint=-1) const
	Projects the vector defined on the old mesh onto the new mesh. More...

void	increment_constructor_count (const std::string &name)
	Increments the construction counter. 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...

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

Static Protected Member Functions
static void	get_global_max_error_pair (const Parallel::Communicator &communicator, std::pair< numeric_index_type, Real > &error_pair)
	Static function to return the error pair (index,error) that is corresponds to the largest error on all processors. More...

static void	generate_training_parameters_random (const Parallel::Communicator &communicator, std::map< std::string, bool > log_param_scale, std::map< std::string, std::unique_ptr< NumericVector< Number >>> &training_parameters_in, unsigned int n_training_samples_in, const RBParameters &min_parameters, const RBParameters &max_parameters, int training_parameters_random_seed=-1, bool serial_training_set=false)
	Static helper function for generating a randomized set of parameters. More...

static void	generate_training_parameters_deterministic (const Parallel::Communicator &communicator, std::map< std::string, bool > log_param_scale, std::map< std::string, std::unique_ptr< NumericVector< Number >>> &training_parameters_in, unsigned int n_training_samples_in, const RBParameters &min_parameters, const RBParameters &max_parameters, bool serial_training_set=false)
	Static helper function for generating a deterministic set of parameters. More...

Protected Attributes
Real	SCM_training_tolerance
	Tolerance which controls when to terminate the SCM Greedy. More...

std::string	RB_system_name
	The name of the associated RB system. More...

bool	quiet_mode
	Flag to indicate whether we print out extra information during the Offline stage. More...

bool	serial_training_set
	This boolean flag indicates whether or not the training set should be the same on all processors. More...

std::unique_ptr< NumericVector< Number > >	inner_product_storage_vector
	We keep an extra temporary vector that is useful for performing inner products (avoids unnecessary memory allocation/deallocation). More...

const Parallel::Communicator &	_communicator

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

static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. 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 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...

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

Private Attributes
RBSCMEvaluation *	rb_scm_eval
	The current RBSCMEvaluation object we are using to perform the Evaluation stage of the SCM. More...

Detailed Description

This class is part of the rbOOmit framework.

RBSCMConstruction implements the the Successive Constraint Method (SCM) for computing rigorous lower bounds for stability constants.

Author: David J. Knezevic

Date: 2009

Definition at line 53 of file rb_scm_construction.h.

Member Typedef Documentation

◆ const_vectors_iterator

typedef std::map<std::string, NumericVector<Number> *>::const_iterator libMesh::System::const_vectors_iterator

inherited

Definition at line 749 of file system.h.

◆ Counts [1/2]

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.

◆ Counts [2/2]

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.

◆ GradientFunctionPointer

typedef Gradient(* libMesh::System::GradientFunctionPointer) (const Point &p, const Parameters &parameters, const std::string &sys_name, const std::string &unknown_name)

inherited

Definition at line 524 of file system.h.

◆ Parent

typedef RBConstructionBase<CondensedEigenSystem> libMesh::RBSCMConstruction::Parent

The type of the parent.

Definition at line 78 of file rb_scm_construction.h.

◆ sys_type

typedef RBSCMConstruction libMesh::RBSCMConstruction::sys_type

The type of system.

Definition at line 73 of file rb_scm_construction.h.

◆ ValueFunctionPointer

typedef Number(* libMesh::System::ValueFunctionPointer) (const Point &p, const Parameters &Parameters, const std::string &sys_name, const std::string &unknown_name)

inherited

Projects arbitrary functions onto the current solution.

The function value fptr and its gradient gptr are represented by function pointers. A gradient gptr is only required/used for projecting onto finite element spaces with continuous derivatives.

Definition at line 520 of file system.h.

◆ vectors_iterator

typedef std::map<std::string, NumericVector<Number> *>::iterator libMesh::System::vectors_iterator

inherited

Vector iterator typedefs.

Definition at line 748 of file system.h.

Constructor & Destructor Documentation

◆ RBSCMConstruction()

libMesh::RBSCMConstruction::RBSCMConstruction	(	EquationSystems &	es,
		const std::string &	name_in,
		const unsigned int	number_in
	)

Constructor.

Optionally initializes required data structures.

◆ ~RBSCMConstruction()

virtual libMesh::RBSCMConstruction::~RBSCMConstruction ( )

virtual

Destructor.

Member Function Documentation

◆ activate()

void libMesh::System::activate ( )

inherited

Activates the system.

Only active systems are solved.

Definition at line 2073 of file system.h.

References libMesh::System::_active.

 {
   _active = true;
 }

◆ active()

bool libMesh::System::active ( ) const

inherited

Returns: true if the system is active, false otherwise. An active system will be solved.

Definition at line 2065 of file system.h.

References libMesh::System::_active.

 {
   return _active;
 }

◆ add_adjoint_rhs()

NumericVector<Number>& libMesh::System::add_adjoint_rhs ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's adjoint rhs vectors, by default the one corresponding to the first qoi. Creates the vector if it doesn't already exist.

◆ add_adjoint_solution()

NumericVector<Number>& libMesh::System::add_adjoint_solution ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's adjoint solution vectors, by default the one corresponding to the first qoi. Creates the vector if it doesn't already exist.

◆ add_scaled_symm_Aq()

virtual void libMesh::RBSCMConstruction::add_scaled_symm_Aq	(	unsigned int	q_a,
		Number	scalar
	)

protectedvirtual

Add the scaled symmetrized affine matrix from the associated RBSystem to matrix_A.

◆ add_sensitivity_rhs()

NumericVector<Number>& libMesh::System::add_sensitivity_rhs ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's sensitivity rhs vectors, by default the one corresponding to the first parameter. Creates the vector if it doesn't already exist.

◆ add_sensitivity_solution()

NumericVector<Number>& libMesh::System::add_sensitivity_solution ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's solution sensitivity vectors, by default the one corresponding to the first parameter. Creates the vector if it doesn't already exist.

◆ add_variable() [1/2]

unsigned int libMesh::System::add_variable	(	const std::string &	var,
		const FEType &	type,
		const std::set< subdomain_id_type > *const	active_subdomains = `nullptr`
	)

inherited

Adds the variable var to the list of variables for this system.

Returns: The index number for the new variable.

Referenced by SimpleRBConstruction::init_data(), and FETest< order, family, elem_type >::setUp().

◆ add_variable() [2/2]

unsigned int libMesh::System::add_variable	(	const std::string &	var,
		const Order	order = `FIRST`,
		const FEFamily	= `LAGRANGE`,
		const std::set< subdomain_id_type > *const	active_subdomains = `nullptr`
	)

inherited

Adds the variable var to the list of variables for this system.

Same as before, but assumes LAGRANGE as default value for FEType.family.

◆ add_variables() [1/2]

unsigned int libMesh::System::add_variables	(	const std::vector< std::string > &	vars,
		const FEType &	type,
		const std::set< subdomain_id_type > *const	active_subdomains = `nullptr`
	)

inherited

Adds the variable var to the list of variables for this system.

Returns: The index number for the new variable.

◆ add_variables() [2/2]

unsigned int libMesh::System::add_variables	(	const std::vector< std::string > &	vars,
		const Order	order = `FIRST`,
		const FEFamily	= `LAGRANGE`,
		const std::set< subdomain_id_type > *const	active_subdomains = `nullptr`
	)

inherited

Adds the variable var to the list of variables for this system.

Same as before, but assumes LAGRANGE as default value for FEType.family.

◆ add_vector()

NumericVector<Number>& libMesh::System::add_vector	(	const std::string &	vec_name,
		const bool	projections = `true`,
		const ParallelType	type = `PARALLEL`
	)

inherited

Adds the additional vector vec_name to this system.

All the additional vectors are similarly distributed, like the solution, and initialized to zero.

By default vectors added by add_vector are projected to changed grids by reinit(). To zero them instead (more efficient), pass "false" as the second argument

◆ add_weighted_sensitivity_adjoint_solution()

NumericVector<Number>& libMesh::System::add_weighted_sensitivity_adjoint_solution ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's weighted sensitivity adjoint solution vectors, by default the one corresponding to the first qoi. Creates the vector if it doesn't already exist.

◆ add_weighted_sensitivity_solution()

NumericVector<Number>& libMesh::System::add_weighted_sensitivity_solution ( )

inherited

Returns: A reference to the solution of the last weighted sensitivity solve Creates the vector if it doesn't already exist.

◆ adjoint_qoi_parameter_sensitivity()

void libMesh::System::adjoint_qoi_parameter_sensitivity	(	const QoISet &	qoi_indices,
		const ParameterVector &	parameters,
		SensitivityData &	sensitivities
	)

virtualinherited

Solves for parameter sensitivities using the adjoint method.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2316 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ adjoint_solve()

std::pair< unsigned int, Real > libMesh::System::adjoint_solve ( const QoISet & qoi_indices = QoISet() )

virtualinherited

Solves the adjoint system, for the specified qoi indices, or for every qoi if qoi_indices is nullptr.

Must be overridden in derived systems.

Returns: A pair with the total number of linear iterations performed and the (sum of the) final residual norms

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem, and libMesh::DifferentiableSystem.

Definition at line 2300 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ Aq_inner_product()

Number libMesh::RBSCMConstruction::Aq_inner_product	(	unsigned int	q,
		const NumericVector< Number > &	v,
		const NumericVector< Number > &	w
	)

protected

Compute the inner product between two vectors using matrix Aq.

◆ assemble()

virtual void libMesh::EigenSystem::assemble ( )

overridevirtualinherited

Assembles the system matrix.

Reimplemented from libMesh::System.

◆ assemble_qoi()

virtual void libMesh::System::assemble_qoi ( const QoISet & qoi_indices = QoISet() )

virtualinherited

Calls user qoi function.

Can be overridden in derived classes.

Reimplemented in libMesh::FEMSystem, and libMesh::ExplicitSystem.

◆ assemble_qoi_derivative()

virtual void libMesh::System::assemble_qoi_derivative	(	const QoISet &	qoi_indices = `QoISet()`,
		bool	include_liftfunc = `true`,
		bool	apply_constraints = `true`
	)

virtualinherited

Calls user qoi derivative function.

Can be overridden in derived classes.

Reimplemented in libMesh::FEMSystem, and libMesh::ExplicitSystem.

◆ assemble_residual_derivatives()

void libMesh::System::assemble_residual_derivatives ( const ParameterVector & parameters )

virtualinherited

Calls residual parameter derivative function.

Library subclasses use finite differences by default.

This should assemble the sensitivity rhs vectors to hold -(partial R / partial p_i), making them ready to solve the forward sensitivity equation.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2269 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ attach_assemble_function()

void libMesh::System::attach_assemble_function ( void fptrEquationSystems &es, const std::string &name )

inherited

Register a user function to use in assembling the system matrix and RHS.

◆ attach_assemble_object()

void libMesh::System::attach_assemble_object ( Assembly & assemble )

inherited

Register a user object to use in assembling the system matrix and RHS.

◆ attach_constraint_function()

void libMesh::System::attach_constraint_function ( void fptrEquationSystems &es, const std::string &name )

inherited

Register a user function for imposing constraints.

◆ attach_constraint_object()

void libMesh::System::attach_constraint_object ( Constraint & constrain )

inherited

Register a user object for imposing constraints.

◆ attach_deflation_space()

virtual void libMesh::RBSCMConstruction::attach_deflation_space ( )

virtual

Attach the deflation space defined by the specified vector, can be useful in solving constrained eigenvalue problems.

This function is called at the start of perform_SCM_greedy and by default is does nothing. Override in subclass to attach a specific vector.

Definition at line 156 of file rb_scm_construction.h.

156 {}

◆ attach_init_function()

void libMesh::System::attach_init_function ( void fptrEquationSystems &es, const std::string &name )

inherited

Register a user function to use in initializing the system.

◆ attach_init_object()

void libMesh::System::attach_init_object ( Initialization & init )

inherited

Register a user class to use to initialize the system.

Note: This is exclusive with the attach_init_function.

◆ attach_QOI_derivative()

void libMesh::System::attach_QOI_derivative ( void fptrEquationSystems &es, const std::string &name, const QoISet &qoi_indices, bool include_liftfunc, bool apply_constraints )

inherited

Register a user function for evaluating derivatives of a quantity of interest with respect to test functions, whose values should be placed in System::rhs.

◆ attach_QOI_derivative_object()

void libMesh::System::attach_QOI_derivative_object ( QOIDerivative & qoi_derivative )

inherited

Register a user object for evaluating derivatives of a quantity of interest with respect to test functions, whose values should be placed in System::rhs.

◆ attach_QOI_function()

void libMesh::System::attach_QOI_function ( void fptrEquationSystems &es, const std::string &name, const QoISet &qoi_indices )

inherited

Register a user function for evaluating the quantities of interest, whose values should be placed in System::qoi.

◆ attach_QOI_object()

void libMesh::System::attach_QOI_object ( QOI & qoi )

inherited

Register a user object for evaluating the quantities of interest, whose values should be placed in System::qoi.

◆ B_inner_product()

Number libMesh::RBSCMConstruction::B_inner_product	(	const NumericVector< Number > &	v,
		const NumericVector< Number > &	w
	)		const

protected

Compute the inner product between two vectors using the system's matrix_B.

◆ boundary_project_solution() [1/2]

void libMesh::System::boundary_project_solution	(	const std::set< boundary_id_type > &	b,
		const std::vector< unsigned int > &	variables,
		FunctionBase< Number > *	f,
		FunctionBase< Gradient > *	g = `nullptr`
	)

inherited

Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system.

Only degrees of freedom which affect the function's trace on a boundary in the set b are affected. Only degrees of freedom associated with the variables listed in the vector variables are projected. The function value f and its gradient g are user-provided cloneable functors. A gradient g is only required/used for projecting onto finite element spaces with continuous derivatives. If non-default Parameters are to be used, they can be provided in the parameters argument.

◆ boundary_project_solution() [2/2]

void libMesh::System::boundary_project_solution	(	const std::set< boundary_id_type > &	b,
		const std::vector< unsigned int > &	variables,
		ValueFunctionPointer	fptr,
		GradientFunctionPointer	gptr,
		const Parameters &	parameters
	)

inherited

Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system.

Only degrees of freedom which affect the function's trace on a boundary in the set b are affected. Only degrees of freedom associated with the variables listed in the vector variables are projected. The function value fptr and its gradient gptr are represented by function pointers. A gradient gptr is only required/used for projecting onto finite element spaces with continuous derivatives.

◆ boundary_project_vector() [1/2]

void libMesh::System::boundary_project_vector	(	const std::set< boundary_id_type > &	b,
		const std::vector< unsigned int > &	variables,
		NumericVector< Number > &	new_vector,
		FunctionBase< Number > *	f,
		FunctionBase< Gradient > *	g = `nullptr`,
		int	is_adjoint = `-1`
	)		const

inherited

Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system.

Only degrees of freedom which affect the function's trace on a boundary in the set b are affected. Only degrees of freedom associated with the variables listed in the vector variables are projected. The function value f and its gradient g are user-provided cloneable functors. A gradient g is only required/used for projecting onto finite element spaces with continuous derivatives. If non-default Parameters are to be used, they can be provided in the parameters argument.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ boundary_project_vector() [2/2]

void libMesh::System::boundary_project_vector	(	const std::set< boundary_id_type > &	b,
		const std::vector< unsigned int > &	variables,
		ValueFunctionPointer	fptr,
		GradientFunctionPointer	gptr,
		const Parameters &	parameters,
		NumericVector< Number > &	new_vector,
		int	is_adjoint = `-1`
	)		const

inherited

Projects arbitrary boundary functions onto a vector of degree of freedom values for the current system.

Only degrees of freedom which affect the function's trace on a boundary in the set b are affected. Only degrees of freedom associated with the variables listed in the vector variables are projected. The function value fptr and its gradient gptr are represented by function pointers. A gradient gptr is only required/used for projecting onto finite element spaces with continuous derivatives.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ broadcast_parameters()

void libMesh::RBConstructionBase< CondensedEigenSystem >::broadcast_parameters ( unsigned int proc_id )

inherited

Broadcasts parameters on processor proc_id to all processors.

◆ calculate_norm() [1/2]

Real libMesh::System::calculate_norm	(	const NumericVector< Number > &	v,
		unsigned int	var,
		FEMNormType	norm_type,
		std::set< unsigned int > *	skip_dimensions = `nullptr`
	)		const

inherited

Returns: A norm of variable var in the vector v, in the specified norm (e.g. L2, L_INF, H1)

◆ calculate_norm() [2/2]

Real libMesh::System::calculate_norm	(	const NumericVector< Number > &	v,
		const SystemNorm &	norm,
		std::set< unsigned int > *	skip_dimensions = `nullptr`
	)		const

inherited

Returns: A norm of the vector v, using component_norm and component_scale to choose and weight the norms of each variable.

◆ clear()

virtual void libMesh::RBSCMConstruction::clear ( )

overridevirtual

Clear all the data structures associated with the system.

Reimplemented from libMesh::RBConstructionBase< CondensedEigenSystem >.

◆ comm()

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

inherited

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

Definition at line 89 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().

90 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ compare()

virtual bool libMesh::System::compare	(	const System &	other_system,
		const Real	threshold,
		const bool	verbose
	)		const

virtualinherited

Returns: true when the other system contains identical data, up to the given threshold. Outputs some diagnostic info when verbose is set.

◆ compute_SCM_bounding_box()

virtual void libMesh::RBSCMConstruction::compute_SCM_bounding_box ( )

protectedvirtual

Compute the SCM bounding box.

◆ compute_SCM_bounds_on_training_set()

virtual std::pair<unsigned int,Real> libMesh::RBSCMConstruction::compute_SCM_bounds_on_training_set ( )

protectedvirtual

Compute upper and lower bounds for each SCM training point.

Return a pair containing the maximum SCM error, and the index of the parameter in the training set at which the max error is achieved.

◆ current_solution()

Number libMesh::System::current_solution ( const dof_id_type global_dof_number ) const

inherited

Returns: The current solution for the specified global DOF.

◆ deactivate()

void libMesh::System::deactivate ( )

inherited

Deactivates the system.

Only active systems are solved.

Definition at line 2081 of file system.h.

References libMesh::System::_active.

 {
   _active = false;
 }

◆ disable_cache()

void libMesh::System::disable_cache ( )

virtualinherited

Avoids use of any cached data that might affect any solve result.

Should be overridden in derived systems.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2275 of file system.h.

References libMesh::System::assemble_before_solve.

2275 { assemble_before_solve = true; }

libMesh::System::assemble_before_solve

bool assemble_before_solve

Flag which tells the system to whether or not to call the user assembly function during each call to ...

Definition: system.h:1477

◆ disable_print_counter_info() [1/2]

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ disable_print_counter_info() [2/2]

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ enable_print_counter_info() [1/2]

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ enable_print_counter_info() [2/2]

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ enrich_C_J()

virtual void libMesh::RBSCMConstruction::enrich_C_J ( unsigned int new_C_J_index )

protectedvirtual

Enrich C_J by adding the element of SCM_training_samples that has the largest gap between alpha_LB and alpha_LB.

◆ evaluate_stability_constant()

virtual void libMesh::RBSCMConstruction::evaluate_stability_constant ( )

protectedvirtual

Compute the stability constant for current_parameters by solving a generalized eigenvalue problem over the truth space.

◆ forward_qoi_parameter_sensitivity()

void libMesh::System::forward_qoi_parameter_sensitivity	(	const QoISet &	qoi_indices,
		const ParameterVector &	parameters,
		SensitivityData &	sensitivities
	)

virtualinherited

Solves for parameter sensitivities using the forward method.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2325 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ generalized()

bool libMesh::EigenSystem::generalized ( ) const

inherited

Returns: true if the underlying problem is generalized , false otherwise.

Definition at line 149 of file eigen_system.h.

References libMesh::EigenSystem::_is_generalized_eigenproblem.

149 { return _is_generalized_eigenproblem; }

libMesh::EigenSystem::_is_generalized_eigenproblem

bool _is_generalized_eigenproblem

A boolean flag to indicate whether we are dealing with a generalized eigenvalue problem.

Definition: eigen_system.h:213

◆ generate_training_parameters_deterministic()

static void libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic	(	const Parallel::Communicator &	communicator,
		std::map< std::string, bool >	log_param_scale,
		std::map< std::string, std::unique_ptr< NumericVector< Number >>> &	training_parameters_in,
		unsigned int	n_training_samples_in,
		const RBParameters &	min_parameters,
		const RBParameters &	max_parameters,
		bool	serial_training_set = `false`
	)

staticprotectedinherited

Static helper function for generating a deterministic set of parameters.

Only works with 1 or 2 parameters (as defined by the lengths of min/max parameters vectors), otherwise throws an error.

◆ generate_training_parameters_random()

static void libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random	(	const Parallel::Communicator &	communicator,
		std::map< std::string, bool >	log_param_scale,
		std::map< std::string, std::unique_ptr< NumericVector< Number >>> &	training_parameters_in,
		unsigned int	n_training_samples_in,
		const RBParameters &	min_parameters,
		const RBParameters &	max_parameters,
		int	training_parameters_random_seed = `-1`,
		bool	serial_training_set = `false`
	)

staticprotectedinherited

Static helper function for generating a randomized set of parameters.

◆ get_adjoint_rhs() [1/2]

NumericVector<Number>& libMesh::System::get_adjoint_rhs ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's adjoint rhs vectors, by default the one corresponding to the first qoi. This what the user's QoI derivative code should assemble when setting up an adjoint problem

◆ get_adjoint_rhs() [2/2]

const NumericVector<Number>& libMesh::System::get_adjoint_rhs ( unsigned int i = 0 ) const

inherited

Returns: A reference to one of the system's adjoint rhs vectors, by default the one corresponding to the first qoi.

◆ get_adjoint_solution() [1/2]

NumericVector<Number>& libMesh::System::get_adjoint_solution ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's adjoint solution vectors, by default the one corresponding to the first qoi.

◆ get_adjoint_solution() [2/2]

const NumericVector<Number>& libMesh::System::get_adjoint_solution ( unsigned int i = 0 ) const

inherited

Returns: A reference to one of the system's adjoint solution vectors, by default the one corresponding to the first qoi.

◆ get_all_variable_numbers()

void libMesh::System::get_all_variable_numbers ( std::vector< unsigned int > & all_variable_numbers ) const

inherited

Fills all_variable_numbers with all the variable numbers for the variables that have been added to this system.

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

const std::string& libMesh::RBConstructionBase< CondensedEigenSystem >::get_deterministic_training_parameter_name ( ) const

inherited

Get the name of the parameter that we will generate deterministic training parameters for.

◆ get_deterministic_training_parameter_repeats()

unsigned int libMesh::RBConstructionBase< CondensedEigenSystem >::get_deterministic_training_parameter_repeats ( ) const

inherited

Get the number of times each sample of the deterministic training parameter is repeated.

◆ 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_dof_map() [1/2]

const DofMap & libMesh::System::get_dof_map ( ) const

inherited

Returns: A constant reference to this system's _dof_map.

Definition at line 2049 of file system.h.

References libMesh::System::_dof_map.

Referenced by SimpleRBConstruction::init_data(), and FETest< order, family, elem_type >::setUp().

 {
   return *_dof_map;
 }

◆ get_dof_map() [2/2]

DofMap & libMesh::System::get_dof_map ( )

inherited

Returns: A writable reference to this system's _dof_map.

Definition at line 2057 of file system.h.

References libMesh::System::_dof_map.

 {
   return *_dof_map;
 }

◆ get_eigenpair()

virtual std::pair<Real, Real> libMesh::CondensedEigenSystem::get_eigenpair ( dof_id_type i )

overridevirtualinherited

Override get_eigenpair() to retrieve the eigenpair for the condensed eigensolve.

We only set the non-condensed entries of the solution vector (the condensed entries are set to zero by default).

Reimplemented from libMesh::EigenSystem.

◆ get_eigenproblem_type()

EigenProblemType libMesh::EigenSystem::get_eigenproblem_type ( ) const

inherited

Returns: The eigen problem type.

Definition at line 143 of file eigen_system.h.

References libMesh::EigenSystem::_eigen_problem_type.

143 {return _eigen_problem_type;}

libMesh::EigenSystem::_eigen_problem_type

EigenProblemType _eigen_problem_type

The type of the eigenvalue problem.

Definition: eigen_system.h:218

◆ get_equation_systems() [1/2]

const EquationSystems& libMesh::System::get_equation_systems ( ) const

inherited

Returns: A constant reference to this system's parent EquationSystems object.

Definition at line 712 of file system.h.

References libMesh::System::_equation_systems.

Referenced by libMesh::WrappedFunction< Output >::WrappedFunction().

712 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:1890

◆ get_equation_systems() [2/2]

EquationSystems& libMesh::System::get_equation_systems ( )

inherited

Returns: A reference to this system's parent EquationSystems object.

Definition at line 717 of file system.h.

References libMesh::System::_equation_systems.

717 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:1890

◆ get_first_local_training_index()

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::get_first_local_training_index ( ) const

inherited

Get the first local index of the training parameters.

◆ get_global_max_error_pair()

static void libMesh::RBConstructionBase< CondensedEigenSystem >::get_global_max_error_pair	(	const Parallel::Communicator &	communicator,
		std::pair< numeric_index_type, Real > &	error_pair
	)

staticprotectedinherited

Static function to return the error pair (index,error) that is corresponds to the largest error on all processors.

◆ get_info() [1/3]

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

staticinherited

Gets a string containing the reference information.

◆ get_info() [2/3]

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

staticinherited

Gets a string containing the reference information.

◆ get_info() [3/3]

std::string libMesh::System::get_info ( ) const

inherited

Returns: A string containing information about the system.

◆ get_last_local_training_index()

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::get_last_local_training_index ( ) const

inherited

Get the last local index of the training parameters.

◆ get_local_n_training_samples()

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::get_local_n_training_samples ( ) const

inherited

Get the total number of training samples local to this processor.

◆ get_mesh() [1/2]

const MeshBase & libMesh::System::get_mesh ( ) const

inherited

Returns: A constant reference to this systems's _mesh.

Definition at line 2033 of file system.h.

References libMesh::System::_mesh.

Referenced by AssemblyA0::boundary_assembly(), AssemblyA1::boundary_assembly(), and AssemblyA2::boundary_assembly().

 {
   return _mesh;
 }

◆ get_mesh() [2/2]

MeshBase & libMesh::System::get_mesh ( )

inherited

Returns: A reference to this systems's _mesh.

Definition at line 2041 of file system.h.

References libMesh::System::_mesh.

 {
   return _mesh;
 }

◆ get_n_continuous_params()

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

inherited

Get the number of continuous parameters.

◆ get_n_converged()

unsigned int libMesh::EigenSystem::get_n_converged ( ) const

inherited

Returns: The number of converged eigenpairs.

Definition at line 128 of file eigen_system.h.

References libMesh::EigenSystem::_n_converged_eigenpairs.

128 {return _n_converged_eigenpairs;}

libMesh::EigenSystem::_n_converged_eigenpairs

unsigned int _n_converged_eigenpairs

The number of converged eigenpairs.

Definition: eigen_system.h:202

◆ get_n_discrete_params()

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

inherited

Get the number of discrete parameters.

◆ get_n_iterations()

unsigned int libMesh::EigenSystem::get_n_iterations ( ) const

inherited

Returns: The number of eigen solver iterations.

Definition at line 133 of file eigen_system.h.

References libMesh::EigenSystem::_n_iterations.

133 {return _n_iterations;}

libMesh::EigenSystem::_n_iterations

unsigned int _n_iterations

The number of iterations of the eigen solver algorithm.

Definition: eigen_system.h:207

◆ get_n_params()

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

inherited

Get the number of parameters.

◆ get_n_training_samples()

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::get_n_training_samples ( ) const

inherited

Get the total number of training samples.

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

RBParameters libMesh::RBConstructionBase< CondensedEigenSystem >::get_params_from_training_set ( unsigned int index )

protectedinherited

Return the RBParameters in index index of training set.

◆ get_rb_scm_evaluation()

RBSCMEvaluation& libMesh::RBSCMConstruction::get_rb_scm_evaluation ( )

Get a reference to the RBSCMEvaluation object.

◆ get_rb_theta_expansion()

RBThetaExpansion& libMesh::RBSCMConstruction::get_rb_theta_expansion ( )

Get a reference to the RBThetaExpansion object.

◆ get_SCM_training_tolerance()

Real libMesh::RBSCMConstruction::get_SCM_training_tolerance ( ) const

Get/set SCM_training_tolerance: tolerance for SCM greedy.

Definition at line 139 of file rb_scm_construction.h.

References SCM_training_tolerance.

139 { return SCM_training_tolerance; }

libMesh::RBSCMConstruction::SCM_training_tolerance

Real SCM_training_tolerance

Tolerance which controls when to terminate the SCM Greedy.

Definition: rb_scm_construction.h:225

◆ get_sensitivity_rhs() [1/2]

NumericVector<Number>& libMesh::System::get_sensitivity_rhs ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's sensitivity rhs vectors, by default the one corresponding to the first parameter. By default these vectors are built by the library, using finite differences, when assemble_residual_derivatives() is called.

When assembled, this vector should hold -(partial R / partial p_i)

◆ get_sensitivity_rhs() [2/2]

const NumericVector<Number>& libMesh::System::get_sensitivity_rhs ( unsigned int i = 0 ) const

inherited

Returns: A reference to one of the system's sensitivity rhs vectors, by default the one corresponding to the first parameter.

◆ get_sensitivity_solution() [1/2]

NumericVector<Number>& libMesh::System::get_sensitivity_solution ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's solution sensitivity vectors, by default the one corresponding to the first parameter.

◆ get_sensitivity_solution() [2/2]

const NumericVector<Number>& libMesh::System::get_sensitivity_solution ( unsigned int i = 0 ) const

inherited

Returns: A reference to one of the system's solution sensitivity vectors, by default the one corresponding to the first parameter.

◆ get_vector() [1/4]

const NumericVector<Number>& libMesh::System::get_vector ( const std::string & vec_name ) const

inherited

Returns: A const reference to this system's additional vector named vec_name. Access is only granted when the vector is already properly initialized.

◆ get_vector() [2/4]

NumericVector<Number>& libMesh::System::get_vector ( const std::string & vec_name )

inherited

Returns: A writable reference to this system's additional vector named vec_name. Access is only granted when the vector is already properly initialized.

◆ get_vector() [3/4]

const NumericVector<Number>& libMesh::System::get_vector ( const unsigned int vec_num ) const

inherited

Returns: A const reference to this system's additional vector number vec_num (where the vectors are counted starting with 0).

◆ get_vector() [4/4]

NumericVector<Number>& libMesh::System::get_vector ( const unsigned int vec_num )

inherited

Returns: A writable reference to this system's additional vector number vec_num (where the vectors are counted starting with 0).

◆ get_weighted_sensitivity_adjoint_solution() [1/2]

NumericVector<Number>& libMesh::System::get_weighted_sensitivity_adjoint_solution ( unsigned int i = 0 )

inherited

Returns: A reference to one of the system's weighted sensitivity adjoint solution vectors, by default the one corresponding to the first qoi.

◆ get_weighted_sensitivity_adjoint_solution() [2/2]

const NumericVector<Number>& libMesh::System::get_weighted_sensitivity_adjoint_solution ( unsigned int i = 0 ) const

inherited

Returns: A reference to one of the system's weighted sensitivity adjoint solution vectors, by default the one corresponding to the first qoi.

◆ get_weighted_sensitivity_solution() [1/2]

NumericVector<Number>& libMesh::System::get_weighted_sensitivity_solution ( )

inherited

Returns: A reference to the solution of the last weighted sensitivity solve

◆ get_weighted_sensitivity_solution() [2/2]

const NumericVector<Number>& libMesh::System::get_weighted_sensitivity_solution ( ) const

inherited

Returns: A reference to the solution of the last weighted sensitivity solve

◆ has_variable()

bool libMesh::System::has_variable ( const std::string & var ) const

inherited

Returns: true if a variable named var exists in this System

◆ have_vector()

bool libMesh::System::have_vector ( const std::string & vec_name ) const

inherited

Returns: true if this System has a vector associated with the given name, false otherwise.

Definition at line 2225 of file system.h.

References libMesh::System::_vectors.

 {
   return (_vectors.count(vec_name));
 }

◆ hide_output()

bool& libMesh::System::hide_output ( )

inherited

Returns: A writable reference to a boolean that determines if this system can be written to file or not. If set to true, then EquationSystems::write will ignore this system.

Definition at line 1662 of file system.h.

References libMesh::System::_hide_output.

1662 { return _hide_output; }

libMesh::System::_hide_output

bool _hide_output

Are we allowed to write this system to file? If _hide_output is true, then EquationSystems::write wil...

Definition: system.h:2009

◆ identify_variable_groups() [1/2]

bool libMesh::System::identify_variable_groups ( ) const

inherited

Returns: true when VariableGroup structures should be automatically identified, false otherwise.

Definition at line 2201 of file system.h.

References libMesh::System::_identify_variable_groups.

 {
   return _identify_variable_groups;
 }

◆ identify_variable_groups() [2/2]

void libMesh::System::identify_variable_groups ( const bool ivg )

inherited

Toggle automatic VariableGroup identification.

Definition at line 2209 of file system.h.

References libMesh::System::_identify_variable_groups.

 {
   _identify_variable_groups = ivg;
 }

◆ increment_constructor_count() [1/2]

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_constructor_count() [2/2]

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() [1/2]

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

◆ increment_destructor_count() [2/2]

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

◆ init()

void libMesh::System::init ( )

inherited

Initializes degrees of freedom on the current mesh.

Sets the

◆ init_data()

virtual void libMesh::RBConstructionBase< CondensedEigenSystem >::init_data ( )

protectedvirtualinherited

Initializes the member data fields associated with the system, so that, e.g., assemble() may be used.

Reimplemented from libMesh::EigenSystem.

◆ init_matrices()

virtual void libMesh::EigenSystem::init_matrices ( )

protectedvirtualinherited

Initializes the matrices associated with the system.

◆ initialize_condensed_dofs()

void libMesh::CondensedEigenSystem::initialize_condensed_dofs ( const std::set< dof_id_type > & global_condensed_dofs_set = std::set< dof_id_type >() )

inherited

Loop over the dofs on each processor to initialize the list of non-condensed dofs.

These are the dofs in the system that are not contained in global_dirichlet_dofs_set and are not subject to constraints due to adaptive mesh hanging nodes, periodic boundary conditions, or Dirichlet boundary conditions.

Most users will not need to use the global_condensed_dofs_set argument; simply call initialize_condensed_dofs() after any time the EquationSystems (and therefore its constraint equations) gets initialized or reinitialized.

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

◆ initialize_training_parameters()

virtual void libMesh::RBConstructionBase< CondensedEigenSystem >::initialize_training_parameters	(	const RBParameters &	mu_min,
		const RBParameters &	mu_max,
		unsigned int	n_training_parameters,
		std::map< std::string, bool >	log_param_scale,
		bool	deterministic = `true`
	)

virtualinherited

Initialize the parameter ranges and indicate whether deterministic or random training parameters should be used and whether or not we want the parameters to be scaled logarithmically.

◆ is_adjoint_already_solved()

bool libMesh::System::is_adjoint_already_solved ( ) const

inherited

Accessor for the adjoint_already_solved boolean.

Definition at line 388 of file system.h.

References libMesh::System::adjoint_already_solved.

389 { return adjoint_already_solved;}

libMesh::System::adjoint_already_solved

bool adjoint_already_solved

Has the adjoint problem already been solved? If the user sets adjoint_already_solved to true...

Definition: system.h:2003

◆ is_discrete_parameter()

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

inherited

Is parameter mu_name discrete?

◆ is_initialized()

bool libMesh::System::is_initialized ( )

inherited

Returns: true iff this system has been initialized.

Definition at line 2089 of file system.h.

References libMesh::System::_is_initialized.

 {
   return _is_initialized;
 }

◆ is_quiet()

bool libMesh::RBConstructionBase< CondensedEigenSystem >::is_quiet ( ) const

inherited

Is the system in quiet mode?

Definition at line 98 of file rb_construction_base.h.

References libMesh::RBConstructionBase< Base >::quiet_mode.

99 { return this->quiet_mode; }

libMesh::RBConstructionBase< CondensedEigenSystem >::quiet_mode

bool quiet_mode

Flag to indicate whether we print out extra information during the Offline stage. ...

Definition: rb_construction_base.h:239

◆ load_matrix_B()

virtual void libMesh::RBSCMConstruction::load_matrix_B ( )

protectedvirtual

Copy over the matrix to store in matrix_B, usually this is the mass or inner-product matrix, but needs to be implemented in subclass.

◆ load_training_set()

virtual void libMesh::RBConstructionBase< CondensedEigenSystem >::load_training_set ( std::map< std::string, std::vector< Number >> & new_training_set )

virtualinherited

Overwrite the training parameters with new_training_set.

◆ local_dof_indices()

void libMesh::System::local_dof_indices	(	const unsigned int	var,
		std::set< dof_id_type > &	var_indices
	)		const

inherited

Fills the std::set with the degrees of freedom on the local processor corresponding the the variable number passed in.

◆ n_active_dofs()

dof_id_type libMesh::System::n_active_dofs ( ) const

inherited

Returns: The number of active degrees of freedom for this System.

Definition at line 2217 of file system.h.

References libMesh::System::n_constrained_dofs(), and libMesh::System::n_dofs().

 {
   return this->n_dofs() - this->n_constrained_dofs();
 }

◆ n_components()

unsigned int libMesh::System::n_components ( ) const

inherited

Returns: The total number of scalar components in the system's variables. This will equal n_vars() in the case of all scalar-valued variables.

Definition at line 2121 of file system.h.

References libMesh::System::_variables, libMesh::Variable::first_scalar_number(), and libMesh::Variable::n_components().

 {
   if (_variables.empty())
     return 0;
 
   const Variable & last = _variables.back();
   return last.first_scalar_number() + last.n_components();
 }

◆ n_constrained_dofs()

dof_id_type libMesh::System::n_constrained_dofs ( ) const

inherited

Returns: The total number of constrained degrees of freedom in the system.

Referenced by libMesh::System::n_active_dofs().

◆ n_dofs()

dof_id_type libMesh::System::n_dofs ( ) const

inherited

Returns: The number of degrees of freedom in the system

Referenced by libMesh::System::n_active_dofs().

◆ n_global_non_condensed_dofs()

dof_id_type libMesh::CondensedEigenSystem::n_global_non_condensed_dofs ( ) const

inherited

Returns: The global number of non-condensed dofs in the system.

◆ n_local_constrained_dofs()

dof_id_type libMesh::System::n_local_constrained_dofs ( ) const

inherited

Returns: The number of constrained degrees of freedom on this processor.

◆ n_local_dofs()

dof_id_type libMesh::System::n_local_dofs ( ) const

inherited

Returns: The number of degrees of freedom local to this processor

◆ n_matrices()

unsigned int libMesh::EigenSystem::n_matrices ( ) const

overridevirtualinherited

Returns: The number of matrices handled by this system

Reimplemented from libMesh::System.

Definition at line 226 of file eigen_system.h.

References libMesh::EigenSystem::_is_generalized_eigenproblem.

 {
   if (_is_generalized_eigenproblem)
     return 2;
 
   return 1;
 }

◆ n_objects() [1/2]

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_objects() [2/2]

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 95 of file parallel_object.h.

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

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

96 { 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:107

◆ n_qois()

unsigned int libMesh::System::n_qois ( ) const

inherited

Number of currently active quantities of interest.

Definition at line 2278 of file system.h.

References libMesh::System::qoi.

Referenced by libMesh::SensitivityData::allocate_data(), and libMesh::SensitivityData::allocate_hessian_data().

 {
   return cast_int<unsigned int>(this->qoi.size());
 }

◆ n_variable_groups()

unsigned int libMesh::System::n_variable_groups ( ) const

inherited

Returns: The number of VariableGroup variable groups in the system

Definition at line 2113 of file system.h.

References libMesh::System::_variable_groups.

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

◆ n_vars()

unsigned int libMesh::System::n_vars ( ) const

inherited

Returns: The number of variables in the system

Definition at line 2105 of file system.h.

References libMesh::System::_variables.

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

◆ n_vectors()

unsigned int libMesh::System::n_vectors ( ) const

inherited

Returns: The number of vectors (in addition to the solution) handled by this system This is the size of the _vectors map

Definition at line 2233 of file system.h.

References libMesh::System::_vectors.

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

◆ name()

const std::string & libMesh::System::name ( ) const

inherited

Returns: The system name.

Definition at line 2017 of file system.h.

References libMesh::System::_sys_name.

 {
   return _sys_name;
 }

◆ number()

unsigned int libMesh::System::number ( ) const

inherited

Returns: The system number.

Definition at line 2025 of file system.h.

References libMesh::System::_sys_number.

 {
   return _sys_number;
 }

◆ perform_SCM_greedy()

virtual void libMesh::RBSCMConstruction::perform_SCM_greedy ( )

virtual

Perform the SCM greedy algorithm to develop a lower bound over the training set.

◆ point_gradient() [1/3]

Gradient libMesh::System::point_gradient	(	unsigned int	var,
		const Point &	p,
		const bool	insist_on_success = `true`
	)		const

inherited

Returns: The gradient of the solution variable var at the physical point p in the mesh, similarly to point_value.

◆ point_gradient() [2/3]

Gradient libMesh::System::point_gradient	(	unsigned int	var,
		const Point &	p,
		const Elem &	e
	)		const

inherited

Returns: The gradient of the solution variable var at the physical point p in local Elem e in the mesh, similarly to point_value.

◆ point_gradient() [3/3]

Gradient libMesh::System::point_gradient	(	unsigned int	var,
		const Point &	p,
		const Elem *	e
	)		const

inherited

Calls the version of point_gradient() which takes a reference.

This function exists only to prevent people from calling the version of point_gradient() that has a boolean third argument, which would result in unnecessary PointLocator calls.

◆ point_hessian() [1/3]

Tensor libMesh::System::point_hessian	(	unsigned int	var,
		const Point &	p,
		const bool	insist_on_success = `true`
	)		const

inherited

Returns: The second derivative tensor of the solution variable var at the physical point p in the mesh, similarly to point_value.

◆ point_hessian() [2/3]

Tensor libMesh::System::point_hessian	(	unsigned int	var,
		const Point &	p,
		const Elem &	e
	)		const

inherited

Returns: The second derivative tensor of the solution variable var at the physical point p in local Elem e in the mesh, similarly to point_value.

◆ point_hessian() [3/3]

Tensor libMesh::System::point_hessian	(	unsigned int	var,
		const Point &	p,
		const Elem *	e
	)		const

inherited

Calls the version of point_hessian() which takes a reference.

This function exists only to prevent people from calling the version of point_hessian() that has a boolean third argument, which would result in unnecessary PointLocator calls.

◆ point_value() [1/3]

Number libMesh::System::point_value	(	unsigned int	var,
		const Point &	p,
		const bool	insist_on_success = `true`
	)		const

inherited

Returns: The value of the solution variable var at the physical point p in the mesh, without knowing a priori which element contains p.

Note: This function uses MeshBase::sub_point_locator(); users may or may not want to call MeshBase::clear_point_locator() afterward. Also, point_locator() is expensive (N log N for initial construction, log N for evaluations). Avoid using this function in any context where you are already looping over elements.

Because the element containing p may lie on any processor, this function is parallel-only.

By default this method expects the point to reside inside the domain and will abort if no element can be found which contains p. The optional parameter insist_on_success can be set to false to allow the method to return 0 when the point is not located.

◆ point_value() [2/3]

Number libMesh::System::point_value	(	unsigned int	var,
		const Point &	p,
		const Elem &	e
	)		const

inherited

Returns: The value of the solution variable var at the physical point p contained in local Elem e

This version of point_value can be run in serial, but assumes e is in the local mesh partition or is algebraically ghosted.

◆ point_value() [3/3]

Number libMesh::System::point_value	(	unsigned int	var,
		const Point &	p,
		const Elem *	e
	)		const

inherited

Calls the version of point_value() which takes a reference.

This function exists only to prevent people from calling the version of point_value() that has a boolean third argument, which would result in unnecessary PointLocator calls.

◆ print_discrete_parameter_values()

void libMesh::RBParametrized::print_discrete_parameter_values ( ) const

inherited

Print out all the discrete parameter values.

◆ print_info() [1/3]

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

staticinherited

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

◆ print_info() [2/3]

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

staticinherited

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

◆ print_info() [3/3]

virtual void libMesh::RBSCMConstruction::print_info ( )

virtual

Print out info that describes the current setup of this RBSCMConstruction.

◆ print_parameters()

void libMesh::RBParametrized::print_parameters ( ) const

inherited

Print the current parameters.

◆ process_parameters_file()

virtual void libMesh::RBSCMConstruction::process_parameters_file ( const std::string & parameters_filename )

virtual

Read in the parameters from file specified by parameters_filename and set the this system's member variables accordingly.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns: The rank of this processor in the group.

Definition at line 101 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().

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

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ project_solution() [1/3]

void libMesh::System::project_solution	(	FunctionBase< Number > *	f,
		FunctionBase< Gradient > *	g = `nullptr`
	)		const

inherited

Projects arbitrary functions onto the current solution.

The function value f and its gradient g are user-provided cloneable functors. A gradient g is only required/used for projecting onto finite element spaces with continuous derivatives. If non-default Parameters are to be used, they can be provided in the parameters argument.

Referenced by FETest< order, family, elem_type >::setUp().

◆ project_solution() [2/3]

void libMesh::System::project_solution	(	FEMFunctionBase< Number > *	f,
		FEMFunctionBase< Gradient > *	g = `nullptr`
	)		const

inherited

Projects arbitrary functions onto the current solution.

The function value f and its gradient g are user-provided cloneable functors. A gradient g is only required/used for projecting onto finite element spaces with continuous derivatives. If non-default Parameters are to be used, they can be provided in the parameters argument.

◆ project_solution() [3/3]

void libMesh::System::project_solution	(	ValueFunctionPointer	fptr,
		GradientFunctionPointer	gptr,
		const Parameters &	parameters
	)		const

inherited

◆ project_solution_on_reinit()

bool& libMesh::System::project_solution_on_reinit ( void )

inherited

Tells the System whether or not to project the solution vector onto new grids when the system is reinitialized.

The solution will be projected unless project_solution_on_reinit() = false is called.

Definition at line 794 of file system.h.

References libMesh::System::_solution_projection.

795 { return _solution_projection; }

libMesh::System::_solution_projection

bool _solution_projection

Holds true if the solution vector should be projected onto a changed grid, false if it should be zero...

Definition: system.h:1959

◆ project_vector() [1/5]

void libMesh::System::project_vector	(	NumericVector< Number > &	new_vector,
		FunctionBase< Number > *	f,
		FunctionBase< Gradient > *	g = `nullptr`,
		int	is_adjoint = `-1`
	)		const

inherited

Projects arbitrary functions onto a vector of degree of freedom values for the current system.

The function value f and its gradient g are user-provided cloneable functors. A gradient g is only required/used for projecting onto finite element spaces with continuous derivatives. If non-default Parameters are to be used, they can be provided in the parameters argument.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ project_vector() [2/5]

void libMesh::System::project_vector	(	NumericVector< Number > &	new_vector,
		FEMFunctionBase< Number > *	f,
		FEMFunctionBase< Gradient > *	g = `nullptr`,
		int	is_adjoint = `-1`
	)		const

inherited

Projects arbitrary functions onto a vector of degree of freedom values for the current system.

The function value f and its gradient g are user-provided cloneable functors. A gradient g is only required/used for projecting onto finite element spaces with continuous derivatives. If non-default Parameters are to be used, they can be provided in the parameters argument.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ project_vector() [3/5]

void libMesh::System::project_vector	(	ValueFunctionPointer	fptr,
		GradientFunctionPointer	gptr,
		const Parameters &	parameters,
		NumericVector< Number > &	new_vector,
		int	is_adjoint = `-1`
	)		const

inherited

Projects arbitrary functions onto a vector of degree of freedom values for the current system.

The function value fptr and its gradient gptr are represented by function pointers. A gradient gptr is only required/used for projecting onto finite element spaces with continuous derivatives.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ project_vector() [4/5]

void libMesh::System::project_vector	(	NumericVector< Number > &	,
		int	is_adjoint = `-1`
	)		const

protectedinherited

Projects the vector defined on the old mesh onto the new mesh.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ project_vector() [5/5]

void libMesh::System::project_vector	(	const NumericVector< Number > &	,
		NumericVector< Number > &	,
		int	is_adjoint = `-1`
	)		const

protectedinherited

Projects the vector defined on the old mesh onto the new mesh.

The original vector is unchanged and the new vector is passed through the second argument.

Constrain the new vector using the requested adjoint rather than primal constraints if is_adjoint is non-negative.

◆ projection_matrix()

void libMesh::System::projection_matrix ( SparseMatrix< Number > & proj_mat ) const

inherited

This method creates a projection matrix which corresponds to the operation of project_vector between old and new solution spaces.

Heterogeneous Dirichlet boundary conditions are not taken into account here; if this matrix is used for prolongation (mesh refinement) on a side with a heterogeneous BC, the newly created degrees of freedom on that side will still match the coarse grid approximation of the BC, not the fine grid approximation.

◆ prolong_vectors()

virtual void libMesh::System::prolong_vectors ( )

virtualinherited

Prolong vectors after the mesh has refined.

◆ qoi_parameter_hessian()

void libMesh::System::qoi_parameter_hessian	(	const QoISet &	qoi_indices,
		const ParameterVector &	parameters,
		SensitivityData &	hessian
	)

virtualinherited

For each of the system's quantities of interest q in qoi[qoi_indices], and for a vector of parameters p, the parameter sensitivity Hessian H_ij is defined as H_ij = (d^2 q)/(d p_i d p_j) This Hessian is the output of this method, where for each q_i, H_jk is stored in hessian.second_derivative(i,j,k).

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2334 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ qoi_parameter_hessian_vector_product()

void libMesh::System::qoi_parameter_hessian_vector_product	(	const QoISet &	qoi_indices,
		const ParameterVector &	parameters,
		const ParameterVector &	vector,
		SensitivityData &	product
	)

virtualinherited

For each of the system's quantities of interest q in qoi[qoi_indices], and for a vector of parameters p, the parameter sensitivity Hessian H_ij is defined as H_ij = (d^2 q)/(d p_i d p_j) The Hessian-vector product, for a vector v_k in parameter space, is S_j = H_jk v_k This product is the output of this method, where for each q_i, S_j is stored in sensitivities[i][j].

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2343 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ qoi_parameter_sensitivity()

virtual void libMesh::System::qoi_parameter_sensitivity	(	const QoISet &	qoi_indices,
		const ParameterVector &	parameters,
		SensitivityData &	sensitivities
	)

virtualinherited

Solves for the derivative of each of the system's quantities of interest q in qoi[qoi_indices] with respect to each parameter in parameters, placing the result for qoi i and parameter j into sensitivities[i][j].

Note: parameters is a const vector, not a vector-of-const; parameter values in this vector need to be mutable for finite differencing to work.

Automatically chooses the forward method for problems with more quantities of interest than parameters, or the adjoint method otherwise.

This method is only usable in derived classes which override an implementation.

◆ re_update()

virtual void libMesh::System::re_update ( )

virtualinherited

Re-update the local values when the mesh has changed.

This method takes the data updated by update() and makes it up-to-date on the current mesh.

Reimplemented in libMesh::TransientSystem< RBConstruction >.

◆ read_header()

void libMesh::System::read_header	(	Xdr &	io,
		const std::string &	version,
		const bool	read_header = `true`,
		const bool	read_additional_data = `true`,
		const bool	read_legacy_format = `false`
	)

inherited

Reads the basic data header for this System.

◆ read_legacy_data()

void libMesh::System::read_legacy_data	(	Xdr &	io,
		const bool	read_additional_data = `true`
	)

inherited

Reads additional data, namely vectors, for this System.

Deprecated:: The ability to read XDR data files in the old (aka "legacy") XDR format has been deprecated for many years, this capability may soon disappear altogether.

◆ read_parallel_data() [1/2]

template<typename InValType >

void libMesh::System::read_parallel_data	(	Xdr &	io,
		const bool	read_additional_data
	)

inherited

Reads additional data, namely vectors, for this System.

This method may safely be called on a distributed-memory mesh. This method will read an individual file for each processor in the simulation where the local solution components for that processor are stored.

◆ read_parallel_data() [2/2]

void libMesh::System::read_parallel_data	(	Xdr &	io,
		const bool	read_additional_data
	)

inherited

Non-templated version for backward compatibility.

Reads additional data, namely vectors, for this System. This method may safely be called on a distributed-memory mesh. This method will read an individual file for each processor in the simulation where the local solution components for that processor are stored.

Definition at line 1299 of file system.h.

1301 { read_parallel_data<Number>(io, read_additional_data); }

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

◆ read_serialized_data() [1/2]

template<typename ValType >

void libMesh::System::read_serialized_data	(	Xdr &	io,
		const bool	read_additional_data = `true`
	)

inherited

Reads additional data, namely vectors, for this System.

This method may safely be called on a distributed-memory mesh.

◆ read_serialized_data() [2/2]

void libMesh::System::read_serialized_data	(	Xdr &	io,
		const bool	read_additional_data = `true`
	)

inherited

Non-templated version for backward compatibility.

Reads additional data, namely vectors, for this System. This method may safely be called on a distributed-memory mesh.

Definition at line 1257 of file system.h.

1259 { read_serialized_data<Number>(io, read_additional_data); }

◆ read_serialized_vectors() [1/2]

template<typename InValType >

std::size_t libMesh::System::read_serialized_vectors	(	Xdr &	io,
		const std::vector< NumericVector< Number > *> &	vectors
	)		const

inherited

Read a number of identically distributed vectors.

This method allows for optimization for the multiple vector case by only communicating the metadata once.

◆ read_serialized_vectors() [2/2]

std::size_t libMesh::System::read_serialized_vectors	(	Xdr &	io,
		const std::vector< NumericVector< Number > *> &	vectors
	)		const

inherited

Non-templated version for backward compatibility.

Read a number of identically distributed vectors. This method allows for optimization for the multiple vector case by only communicating the metadata once.

Definition at line 1277 of file system.h.

1279 { return read_serialized_vectors<Number>(io, vectors); }

◆ reinit()

virtual void libMesh::EigenSystem::reinit ( )

overridevirtualinherited

Reinitializes the member data fields associated with the system, so that, e.g., assemble() may be used.

Reimplemented from libMesh::System.

◆ reinit_constraints()

virtual void libMesh::System::reinit_constraints ( )

virtualinherited

Reinitializes the constraints for this system.

◆ remove_vector()

void libMesh::System::remove_vector ( const std::string & vec_name )

inherited

Removes the additional vector vec_name from this system.

◆ request_vector() [1/4]

const NumericVector<Number>* libMesh::System::request_vector ( const std::string & vec_name ) const

inherited

Returns: A const pointer to the vector if this System has a vector associated with the given name, nullptr otherwise.

◆ request_vector() [2/4]

NumericVector<Number>* libMesh::System::request_vector ( const std::string & vec_name )

inherited

Returns: A pointer to the vector if this System has a vector associated with the given name, nullptr otherwise.

◆ request_vector() [3/4]

const NumericVector<Number>* libMesh::System::request_vector ( const unsigned int vec_num ) const

inherited

Returns: A const pointer to this system's additional vector number vec_num (where the vectors are counted starting with 0), or nullptr if the system has no such vector.

◆ request_vector() [4/4]

NumericVector<Number>* libMesh::System::request_vector ( const unsigned int vec_num )

inherited

Returns: A writable pointer to this system's additional vector number vec_num (where the vectors are counted starting with 0), or nullptr if the system has no such vector.

◆ resize_SCM_vectors()

virtual void libMesh::RBSCMConstruction::resize_SCM_vectors ( )

virtual

Clear and resize the SCM data vectors.

Override in subclass as necessary.

◆ restrict_solve_to()

virtual void libMesh::System::restrict_solve_to	(	const SystemSubset *	subset,
		const SubsetSolveMode	subset_solve_mode = `SUBSET_ZERO`
	)

virtualinherited

After calling this method, any solve will be restricted to the given subdomain.

To disable this mode, call this method with subset being a nullptr.

Reimplemented in libMesh::LinearImplicitSystem.

◆ restrict_vectors()

virtual void libMesh::System::restrict_vectors ( )

virtualinherited

Restrict vectors after the mesh has coarsened.

◆ SCM_greedy_error_indicator()

virtual Real libMesh::RBSCMConstruction::SCM_greedy_error_indicator	(	Real	LB,
		Real	UB
	)

protectedvirtual

Helper function which provides an error indicator to be used in the SCM greedy.

Override in subclasses to specialize behavior.

Definition at line 218 of file rb_scm_construction.h.

218 { return fabs(UB-LB)/fabs(UB); }

◆ sensitivity_solve()

std::pair< unsigned int, Real > libMesh::System::sensitivity_solve ( const ParameterVector & parameters )

virtualinherited

Solves the sensitivity system, for the provided parameters.

Must be overridden in derived systems.

Returns: A pair with the total number of linear iterations performed and the (sum of the) final residual norms

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2285 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ set_adjoint_already_solved()

void libMesh::System::set_adjoint_already_solved ( bool setting )

inherited

Setter for the adjoint_already_solved boolean.

Definition at line 394 of file system.h.

References libMesh::System::adjoint_already_solved.

395 { adjoint_already_solved = setting;}

libMesh::System::adjoint_already_solved

bool adjoint_already_solved

Has the adjoint problem already been solved? If the user sets adjoint_already_solved to true...

Definition: system.h:2003

◆ set_basic_system_only()

void libMesh::System::set_basic_system_only ( )

inherited

Sets the system to be "basic only": i.e.

advanced system components such as ImplicitSystem matrices may not be initialized. This is useful for efficiency in certain utility programs that never use System::solve(). This method must be called after the System or derived class is created but before it is initialized; e.g. from within EquationSystems::read()

Definition at line 2097 of file system.h.

References libMesh::System::_basic_system_only.

 {
   _basic_system_only = true;
 }

◆ set_deterministic_training_parameter_name()

void libMesh::RBConstructionBase< CondensedEigenSystem >::set_deterministic_training_parameter_name ( const std::string & name )

inherited

In some cases we only want to allow discrete parameter values, instead of parameters that may take any value in a specified interval.

Here we provide a method to set the d Set the discrete values for parameter mu that are allowed in the training set. This must be called before the training set is generated. Set the name of the parameter that we will generate deterministic training parameters for. Defaults to "NONE".

◆ set_deterministic_training_parameter_repeats()

void libMesh::RBConstructionBase< CondensedEigenSystem >::set_deterministic_training_parameter_repeats ( unsigned int repeats )

inherited

Set the number of times each sample of the deterministic training parameter is repeated.

◆ set_eigenproblem_type()

void libMesh::EigenSystem::set_eigenproblem_type ( EigenProblemType ept )

inherited

Sets the type of the current eigen problem.

◆ set_eigensolver_properties()

virtual void libMesh::RBSCMConstruction::set_eigensolver_properties ( int )

virtual

This function is called before truth eigensolves in compute_SCM_bounding_box and evaluate_stability_constant.

Override it to set specific properties to optimize eigensolver performance. The argument refers to the operator index in compute_SCM_bounding_box; a negative value of the argument indicates we are not performing a bounding box solve.

Definition at line 127 of file rb_scm_construction.h.

127 {}

◆ set_n_converged()

void libMesh::EigenSystem::set_n_converged ( unsigned int nconv )

protectedinherited

Set the _n_converged_eigenpairs member, useful for subclasses of EigenSystem.

Definition at line 186 of file eigen_system.h.

References libMesh::EigenSystem::_n_converged_eigenpairs.

187 { _n_converged_eigenpairs = nconv; }

libMesh::EigenSystem::_n_converged_eigenpairs

unsigned int _n_converged_eigenpairs

The number of converged eigenpairs.

Definition: eigen_system.h:202

◆ set_n_iterations()

void libMesh::EigenSystem::set_n_iterations ( unsigned int its )

protectedinherited

Set the _n_iterations member, useful for subclasses of EigenSystem.

Definition at line 193 of file eigen_system.h.

References libMesh::EigenSystem::_n_iterations.

194 { _n_iterations = its;}

libMesh::EigenSystem::_n_iterations

unsigned int _n_iterations

The number of iterations of the eigen solver algorithm.

Definition: eigen_system.h:207

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

void libMesh::RBConstructionBase< CondensedEigenSystem >::set_params_from_training_set ( unsigned int index )

protectedinherited

Set parameters to the RBParameters stored in index index of the training set.

◆ set_params_from_training_set_and_broadcast()

virtual void libMesh::RBConstructionBase< CondensedEigenSystem >::set_params_from_training_set_and_broadcast ( unsigned int index )

protectedvirtualinherited

Load the specified training parameter and then broadcast to all processors.

◆ set_quiet_mode()

void libMesh::RBConstructionBase< CondensedEigenSystem >::set_quiet_mode ( bool quiet_mode_in )

inherited

Set the quiet_mode flag.

If quiet == false then we print out a lot of extra information during the Offline stage.

Definition at line 92 of file rb_construction_base.h.

References libMesh::RBConstructionBase< Base >::quiet_mode.

93 { this->quiet_mode = quiet_mode_in; }

libMesh::RBConstructionBase< CondensedEigenSystem >::quiet_mode

bool quiet_mode

Flag to indicate whether we print out extra information during the Offline stage. ...

Definition: rb_construction_base.h:239

◆ set_rb_scm_evaluation()

void libMesh::RBSCMConstruction::set_rb_scm_evaluation ( RBSCMEvaluation & rb_scm_eval_in )

Set the RBSCMEvaluation object.

◆ set_RB_system_name()

void libMesh::RBSCMConstruction::set_RB_system_name ( const std::string & new_name )

Set the name of the associated RB system — we need this to load the (symmetrized) affine operators.

Definition at line 133 of file rb_scm_construction.h.

References RB_system_name.

134 { RB_system_name = new_name; }

libMesh::RBSCMConstruction::RB_system_name

std::string RB_system_name

The name of the associated RB system.

Definition: rb_scm_construction.h:230

◆ set_SCM_training_tolerance()

void libMesh::RBSCMConstruction::set_SCM_training_tolerance ( Real SCM_training_tolerance_in )

Definition at line 140 of file rb_scm_construction.h.

References SCM_training_tolerance.

140 { this->SCM_training_tolerance = SCM_training_tolerance_in; }

libMesh::RBSCMConstruction::SCM_training_tolerance

Real SCM_training_tolerance

Tolerance which controls when to terminate the SCM Greedy.

Definition: rb_scm_construction.h:225

◆ set_training_random_seed()

void libMesh::RBConstructionBase< CondensedEigenSystem >::set_training_random_seed ( unsigned int seed )

inherited

Set the seed that is used to randomly generate training parameters.

◆ set_vector_as_adjoint()

void libMesh::System::set_vector_as_adjoint	(	const std::string &	vec_name,
		int	qoi_num
	)

inherited

Allows one to set the QoI index controlling whether the vector identified by vec_name represents a solution from the adjoint (qoi_num >= 0) or primal (qoi_num == -1) space.

This becomes significant if those spaces have differing heterogeneous Dirichlet constraints.

qoi_num == -2 can be used to indicate a vector which should not be affected by constraints during projection operations.

◆ set_vector_preservation()

void libMesh::System::set_vector_preservation	(	const std::string &	vec_name,
		bool	preserve
	)

inherited

Allows one to set the boolean controlling whether the vector identified by vec_name should be "preserved": projected to new meshes, saved, etc.

◆ solve()

virtual void libMesh::CondensedEigenSystem::solve ( )

overridevirtualinherited

Override to solve the condensed eigenproblem with the dofs in local_non_condensed_dofs_vector stripped out of the system matrices on each processor.

Reimplemented from libMesh::EigenSystem.

◆ system()

sys_type& libMesh::RBConstructionBase< CondensedEigenSystem >::system ( )

inherited

Returns: A reference to *this.

Definition at line 79 of file rb_construction_base.h.

79 { return *this; }

◆ system_type()

virtual std::string libMesh::EigenSystem::system_type ( ) const

overridevirtualinherited

Returns: "Eigen". Helps in identifying the system type in an equation system file.

Reimplemented from libMesh::System.

Definition at line 118 of file eigen_system.h.

118 { return "Eigen"; }

◆ update()

virtual void libMesh::System::update ( )

virtualinherited

Update the local values to reflect the solution on neighboring processors.

Reimplemented in SolidSystem.

◆ update_global_solution() [1/2]

void libMesh::System::update_global_solution ( std::vector< Number > & global_soln ) const

inherited

Fill the input vector global_soln so that it contains the global solution on all processors.

Requires communication with all other processors.

◆ update_global_solution() [2/2]

void libMesh::System::update_global_solution	(	std::vector< Number > &	global_soln,
		const processor_id_type	dest_proc
	)		const

inherited

Fill the input vector global_soln so that it contains the global solution on processor dest_proc.

Requires communication with all other processors.

◆ user_assembly()

virtual void libMesh::System::user_assembly ( )

virtualinherited

Calls user's attached assembly function, or is overridden by the user in derived classes.

◆ user_constrain()

virtual void libMesh::System::user_constrain ( )

virtualinherited

Calls user's attached constraint function, or is overridden by the user in derived classes.

◆ user_initialization()

virtual void libMesh::System::user_initialization ( )

virtualinherited

Calls user's attached initialization function, or is overridden by the user in derived classes.

◆ user_QOI()

virtual void libMesh::System::user_QOI ( const QoISet & qoi_indices )

virtualinherited

Calls user's attached quantity of interest function, or is overridden by the user in derived classes.

◆ user_QOI_derivative()

virtual void libMesh::System::user_QOI_derivative	(	const QoISet &	qoi_indices = `QoISet()`,
		bool	include_liftfunc = `true`,
		bool	apply_constraints = `true`
	)

virtualinherited

Calls user's attached quantity of interest derivative function, or is overridden by the user in derived classes.

◆ variable()

const Variable & libMesh::System::variable ( unsigned int var ) const

inherited

Return a constant reference to Variable var.

Definition at line 2133 of file system.h.

References libMesh::System::_variables.

 {
   libmesh_assert_less (i, _variables.size());
 
   return _variables[i];
 }

◆ variable_group()

const VariableGroup & libMesh::System::variable_group ( unsigned int vg ) const

inherited

Return a constant reference to VariableGroup vg.

Definition at line 2143 of file system.h.

References libMesh::System::_variable_groups.

 {
   libmesh_assert_less (vg, _variable_groups.size());
 
   return _variable_groups[vg];
 }

◆ variable_name()

const std::string & libMesh::System::variable_name ( const unsigned int i ) const

inherited

Returns: The name of variable i.

Definition at line 2153 of file system.h.

References libMesh::System::_variables.

 {
   libmesh_assert_less (i, _variables.size());
 
   return _variables[i].name();
 }

◆ variable_number()

unsigned short int libMesh::System::variable_number ( const std::string & var ) const

inherited

Returns: The variable number associated with the user-specified variable named var.

Referenced by libMesh::System::variable_scalar_number(), and libMesh::System::variable_type().

◆ variable_scalar_number() [1/2]

unsigned int libMesh::System::variable_scalar_number	(	const std::string &	var,
		unsigned int	component
	)		const

inherited

Returns: An index, starting from 0 for the first component of the first variable, and incrementing for each component of each (potentially vector-valued) variable in the system in order. For systems with only scalar-valued variables, this will be the same as variable_number(var)

Irony: currently our only non-scalar-valued variable type is SCALAR.

Definition at line 2164 of file system.h.

References libMesh::System::variable_number().

 {
   return variable_scalar_number(this->variable_number(var), component);
 }

◆ variable_scalar_number() [2/2]

unsigned int libMesh::System::variable_scalar_number	(	unsigned int	var_num,
		unsigned int	component
	)		const

inherited

Returns: An index, starting from 0 for the first component of the first variable, and incrementing for each component of each (potentially vector-valued) variable in the system in order. For systems with only scalar-valued variables, this will be the same as var_num

Irony: currently our only non-scalar-valued variable type is SCALAR.

Definition at line 2174 of file system.h.

References libMesh::System::_variables.

 {
   return _variables[var_num].first_scalar_number() + component;
 }

◆ variable_type() [1/2]

const FEType & libMesh::System::variable_type ( const unsigned int i ) const

inherited

Returns: The finite element type variable number i.

Definition at line 2183 of file system.h.

References libMesh::System::_variables.

Referenced by FETest< order, family, elem_type >::setUp().

 {
   libmesh_assert_less (i, _variables.size());
 
   return _variables[i].type();
 }

◆ variable_type() [2/2]

const FEType & libMesh::System::variable_type ( const std::string & var ) const

inherited

Returns: The finite element type for variable var.

Definition at line 2193 of file system.h.

References libMesh::System::_variables, and libMesh::System::variable_number().

 {
   return _variables[this->variable_number(var)].type();
 }

◆ vector_is_adjoint()

int libMesh::System::vector_is_adjoint ( const std::string & vec_name ) const

inherited

Returns: The integer describing whether the vector identified by vec_name represents a solution from an adjoint (non-negative) or the primal (-1) space.

◆ vector_name() [1/2]

const std::string& libMesh::System::vector_name ( const unsigned int vec_num ) const

inherited

Returns: The name of this system's additional vector number vec_num (where the vectors are counted starting with 0).

◆ vector_name() [2/2]

const std::string& libMesh::System::vector_name ( const NumericVector< Number > & vec_reference ) const

inherited

Returns: The name of a system vector, given a reference to that vector

◆ vector_preservation()

bool libMesh::System::vector_preservation ( const std::string & vec_name ) const

inherited

Returns: The boolean describing whether the vector identified by vec_name should be "preserved": projected to new meshes, saved, etc.

◆ vectors_begin() [1/2]

System::vectors_iterator libMesh::System::vectors_begin ( )

inherited

Beginning of vectors container.

Definition at line 2245 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.begin();
 }

◆ vectors_begin() [2/2]

System::const_vectors_iterator libMesh::System::vectors_begin ( ) const

inherited

Beginning of vectors container.

Definition at line 2251 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.begin();
 }

◆ vectors_end() [1/2]

System::vectors_iterator libMesh::System::vectors_end ( )

inherited

End of vectors container.

Definition at line 2257 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.end();
 }

◆ vectors_end() [2/2]

System::const_vectors_iterator libMesh::System::vectors_end ( ) const

inherited

End of vectors container.

Definition at line 2263 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.end();
 }

◆ weighted_sensitivity_adjoint_solve()

std::pair< unsigned int, Real > libMesh::System::weighted_sensitivity_adjoint_solve	(	const ParameterVector &	parameters,
		const ParameterVector &	weights,
		const QoISet &	qoi_indices = `QoISet()`
	)

virtualinherited

Assembles & solves the linear system(s) (dR/du)^T*z_w = sum(w_p*(d^2q/dudp - d^2R/dudp*z)), for those parameters p contained within parameters, weighted by the values w_p found within weights.

Assumes that adjoint_solve has already calculated z for each qoi in qoi_indices.

Returns: A pair with the total number of linear iterations performed and the (sum of the) final residual norms

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2307 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ weighted_sensitivity_solve()

std::pair< unsigned int, Real > libMesh::System::weighted_sensitivity_solve	(	const ParameterVector &	parameters,
		const ParameterVector &	weights
	)

virtualinherited

Assembles & solves the linear system(s) (dR/du)*u_w = sum(w_p*-dR/dp), for those parameters p contained within parameters weighted by the values w_p found within weights.

Returns: A pair with the total number of linear iterations performed and the (sum of the) final residual norms

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2292 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ write_header()

void libMesh::System::write_header	(	Xdr &	io,
		const std::string &	version,
		const bool	write_additional_data
	)		const

inherited

Writes the basic data header for this System.

◆ write_parallel_data()

void libMesh::System::write_parallel_data	(	Xdr &	io,
		const bool	write_additional_data
	)		const

inherited

Writes additional data, namely vectors, for this System.

This method may safely be called on a distributed-memory mesh. This method will create an individual file for each processor in the simulation where the local solution components for that processor will be stored.

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

◆ write_serialized_data()

void libMesh::System::write_serialized_data	(	Xdr &	io,
		const bool	write_additional_data = `true`
	)		const

inherited

Writes additional data, namely vectors, for this System.

This method may safely be called on a distributed-memory mesh.

◆ write_serialized_vectors()

std::size_t libMesh::System::write_serialized_vectors	(	Xdr &	io,
		const std::vector< const NumericVector< Number > *> &	vectors
	)		const

inherited

Serialize & write a number of identically distributed vectors.

This method allows for optimization for the multiple vector case by only communicating the metadata once.

◆ zero_variable()

void libMesh::System::zero_variable	(	NumericVector< Number > &	v,
		unsigned int	var_num
	)		const

inherited

Zeroes all dofs in v that correspond to variable number var_num.

Member Data Documentation

◆ _communicator

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

protectedinherited

Definition at line 107 of file parallel_object.h.

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

◆ _counts [1/2]

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

◆ _counts [2/2]

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

◆ _enable_print_counter [1/2]

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.

◆ _enable_print_counter [2/2]

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.

◆ _mutex [1/2]

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.

◆ _mutex [2/2]

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 [1/2]

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

◆ _n_objects [2/2]

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

◆ assemble_before_solve

bool libMesh::System::assemble_before_solve

inherited

Flag which tells the system to whether or not to call the user assembly function during each call to solve().

By default, every call to solve() begins with a call to the user assemble, so this flag is true. (For explicit systems, "solving" the system occurs during the assembly step, so this flag is always true for explicit systems.)

You will only want to set this to false if you need direct control over when the system is assembled, and are willing to track the state of its assembly yourself. An example of such a case is an implicit system with multiple right hand sides. In this instance, a single assembly would likely be followed with multiple calls to solve.

The frequency system and Newmark system have their own versions of this flag, called _finished_assemble, which might be able to be replaced with this more general concept.

Definition at line 1477 of file system.h.

Referenced by libMesh::System::disable_cache().

◆ condensed_matrix_A

std::unique_ptr<SparseMatrix<Number> > libMesh::CondensedEigenSystem::condensed_matrix_A

inherited

The (condensed) system matrix for standard eigenvalue problems.

Definition at line 112 of file condensed_eigen_system.h.

◆ condensed_matrix_B

std::unique_ptr<SparseMatrix<Number> > libMesh::CondensedEigenSystem::condensed_matrix_B

inherited

A second (condensed) system matrix for generalized eigenvalue problems.

Definition at line 117 of file condensed_eigen_system.h.

◆ current_local_solution

std::unique_ptr<NumericVector<Number> > libMesh::System::current_local_solution

inherited

All the values I need to compute my contribution to the simulation at hand.

Think of this as the current solution with any ghost values needed from other processors. This vector is necessarily larger than the solution vector in the case of a parallel simulation. The update() member is used to synchronize the contents of the solution and current_local_solution vectors.

Definition at line 1535 of file system.h.

Referenced by FETest< order, family, elem_type >::testGradU(), FETest< order, family, elem_type >::testGradUComp(), and FETest< order, family, elem_type >::testU().

◆ eigen_solver

std::unique_ptr<EigenSolver<Number> > libMesh::EigenSystem::eigen_solver

inherited

The EigenSolver, defining which interface, i.e solver package to use.

Definition at line 165 of file eigen_system.h.

◆ extra_quadrature_order

int libMesh::System::extra_quadrature_order

inherited

A member int that can be employed to indicate increased or reduced quadrature order.

Note: For FEMSystem users, by default, when calling the user-defined residual functions, the FEMSystem will first set up an appropriate FEType::default_quadrature_rule() object for performing the integration. This rule will integrate elements of order up to 2*p+1 exactly (where p is the sum of the base FEType and local p refinement levels), but if additional (or reduced) quadrature accuracy is desired then this extra_quadrature_order (default 0) will be added.

Definition at line 1508 of file system.h.

◆ inner_product_storage_vector

std::unique_ptr<NumericVector<Number> > libMesh::RBConstructionBase< CondensedEigenSystem >::inner_product_storage_vector

protectedinherited

We keep an extra temporary vector that is useful for performing inner products (avoids unnecessary memory allocation/deallocation).

Definition at line 254 of file rb_construction_base.h.

◆ local_non_condensed_dofs_vector

std::vector<dof_id_type> libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector

inherited

Vector storing the local dof indices that will not be condensed.

All dofs that are not in this vector will be eliminated from the system when we perform a solve.

Definition at line 124 of file condensed_eigen_system.h.

◆ matrix_A

std::unique_ptr<SparseMatrix<Number> > libMesh::EigenSystem::matrix_A

inherited

The system matrix for standard eigenvalue problems.

Definition at line 154 of file eigen_system.h.

◆ matrix_B

std::unique_ptr<SparseMatrix<Number> > libMesh::EigenSystem::matrix_B

inherited

A second system matrix for generalized eigenvalue problems.

Definition at line 159 of file eigen_system.h.

◆ qoi

std::vector<Number> libMesh::System::qoi

inherited

Values of the quantities of interest.

This vector needs to be both resized and filled by the user before any quantity of interest assembly is done and before any sensitivities are calculated.

Definition at line 1558 of file system.h.

Referenced by libMesh::DifferentiableSystem::attach_qoi(), and libMesh::System::n_qois().

◆ quiet_mode

bool libMesh::RBConstructionBase< CondensedEigenSystem >::quiet_mode

protectedinherited

Flag to indicate whether we print out extra information during the Offline stage.

Definition at line 239 of file rb_construction_base.h.

◆ rb_scm_eval

RBSCMEvaluation* libMesh::RBSCMConstruction::rb_scm_eval

private

The current RBSCMEvaluation object we are using to perform the Evaluation stage of the SCM.

Definition at line 238 of file rb_scm_construction.h.

◆ RB_system_name

std::string libMesh::RBSCMConstruction::RB_system_name

protected

The name of the associated RB system.

Definition at line 230 of file rb_scm_construction.h.

Referenced by set_RB_system_name().

◆ SCM_training_tolerance

Real libMesh::RBSCMConstruction::SCM_training_tolerance

protected

Tolerance which controls when to terminate the SCM Greedy.

Definition at line 225 of file rb_scm_construction.h.

Referenced by get_SCM_training_tolerance(), and set_SCM_training_tolerance().

◆ serial_training_set

bool libMesh::RBConstructionBase< CondensedEigenSystem >::serial_training_set

protectedinherited

This boolean flag indicates whether or not the training set should be the same on all processors.

By default it is false, but in the case of the Empirical Interpolation Method (RBEIMConstruction), for example, we need the training set to be identical on all processors.

Definition at line 247 of file rb_construction_base.h.

◆ solution

std::unique_ptr<NumericVector<Number> > libMesh::System::solution

inherited

Data structure to hold solution values.

Definition at line 1523 of file system.h.

◆ time

Real libMesh::System::time

inherited

For time-dependent problems, this is the time t at the beginning of the current timestep.

Note: For DifferentiableSystem users: do not access this time during an assembly! Use the DiffContext::time value instead to get correct results.

Definition at line 1545 of file system.h.

◆ use_fixed_solution

bool libMesh::System::use_fixed_solution

inherited

A boolean to be set to true by systems using elem_fixed_solution, for optional use by e.g.

stabilized methods. False by default.

Note: For FEMSystem users, if this variable is set to true, it must be before init_data() is called.

Definition at line 1493 of file system.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_scm_construction.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_vectors_iterator

◆ Counts [1/2]

◆ Counts [2/2]

◆ GradientFunctionPointer

◆ Parent

◆ sys_type

◆ ValueFunctionPointer

◆ vectors_iterator

Constructor & Destructor Documentation

◆ RBSCMConstruction()

◆ ~RBSCMConstruction()

Member Function Documentation

◆ activate()

◆ active()

◆ add_adjoint_rhs()

◆ add_adjoint_solution()

◆ add_scaled_symm_Aq()

◆ add_sensitivity_rhs()

◆ add_sensitivity_solution()

◆ add_variable() [1/2]

◆ add_variable() [2/2]

◆ add_variables() [1/2]

◆ add_variables() [2/2]

◆ add_vector()

◆ add_weighted_sensitivity_adjoint_solution()

◆ add_weighted_sensitivity_solution()

◆ adjoint_qoi_parameter_sensitivity()

◆ adjoint_solve()

◆ Aq_inner_product()

◆ assemble()

◆ assemble_qoi()

◆ assemble_qoi_derivative()

◆ assemble_residual_derivatives()

◆ attach_assemble_function()

◆ attach_assemble_object()

◆ attach_constraint_function()

◆ attach_constraint_object()

◆ attach_deflation_space()

◆ attach_init_function()

◆ attach_init_object()

◆ attach_QOI_derivative()

◆ attach_QOI_derivative_object()

◆ attach_QOI_function()

◆ attach_QOI_object()

◆ B_inner_product()

◆ boundary_project_solution() [1/2]

◆ boundary_project_solution() [2/2]

◆ boundary_project_vector() [1/2]

◆ boundary_project_vector() [2/2]

◆ broadcast_parameters()

◆ calculate_norm() [1/2]

◆ calculate_norm() [2/2]

◆ clear()

◆ comm()

◆ compare()

◆ compute_SCM_bounding_box()

◆ compute_SCM_bounds_on_training_set()

◆ current_solution()

◆ deactivate()

◆ disable_cache()

◆ disable_print_counter_info() [1/2]

◆ disable_print_counter_info() [2/2]

◆ enable_print_counter_info() [1/2]

◆ enable_print_counter_info() [2/2]

◆ enrich_C_J()

◆ evaluate_stability_constant()

◆ forward_qoi_parameter_sensitivity()

◆ generalized()