#include <eim_classes.h>

Inheritance diagram for SimpleEIMConstruction:

Public Types
enum	BEST_FIT_TYPE { PROJECTION_BEST_FIT, EIM_BEST_FIT, POD_BEST_FIT }

typedef RBEIMEvaluation::QpDataMap	QpDataMap
	Type of the data structure used to map from (elem id) -> [n_vars][n_qp] data. More...

typedef RBEIMEvaluation::SideQpDataMap	SideQpDataMap
	Type of the data structure used to map from (elem id,side_index) -> [n_vars][n_qp] data. More...

typedef RBEIMEvaluation::NodeDataMap	NodeDataMap
	Type of the data structure used to map from node id -> [n_vars] data. More...

typedef RBConstructionBase< System >	sys_type
	The type of system. 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, std::unique_ptr< NumericVector< Number > >, std::less<> >::iterator	vectors_iterator
	Vector iterator typedefs. More...

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

typedef std::map< std::string, std::unique_ptr< SparseMatrix< Number > >, std::less<> >::iterator	matrices_iterator
	Matrix iterator typedefs. More...

typedef std::map< std::string, std::unique_ptr< SparseMatrix< Number > >, std::less<> >::const_iterator	const_matrices_iterator

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

virtual void	init_data ()
	Initialize data structures. More...

virtual std::unique_ptr< ElemAssembly >	build_eim_assembly (unsigned int index)
	Provide an implementation of build_eim_assembly. More...

	SimpleEIMConstruction (EquationSystems &es, const std::string &name_in, const unsigned int number_in)
	Constructor. More...

virtual std::unique_ptr< ElemAssembly >	build_eim_assembly (unsigned int index)
	Provide an implementation of build_eim_assembly. More...

virtual void	init_data ()
	Initialize data structures. More...

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

void	set_rb_eim_evaluation (RBEIMEvaluation &rb_eim_eval_in)
	Set the RBEIMEvaluation object. More...

RBEIMEvaluation &	get_rb_eim_evaluation ()
	Get a reference to the RBEvaluation object. More...

const RBEIMEvaluation &	get_rb_eim_evaluation () const
	Get a const reference to the RBEvaluation object. More...

void	initialize_eim_construction ()
	Perform initialization of this object to prepare for running train_eim_approximation(). More...

virtual void	process_parameters_file (const std::string &parameters_filename)
	Read parameters in from file and set up this system accordingly. More...

void	set_rb_construction_parameters (unsigned int n_training_samples_in, bool deterministic_training_in, int training_parameters_random_seed_in, bool quiet_mode_in, unsigned int Nmax_in, Real rel_training_tolerance_in, Real abs_training_tolerance_in, const RBParameters &mu_min_in, const RBParameters &mu_max_in, const std::map< std::string, std::vector< Real >> &discrete_parameter_values_in, const std::map< std::string, bool > &log_scaling, std::map< std::string, std::vector< RBParameter >> *training_sample_list=nullptr)
	Set the state of this RBConstruction object based on the arguments to this function. More...

virtual void	set_best_fit_type_flag (const std::string &best_fit_type_string)
	Specify which type of "best fit" we use to guide the EIM greedy algorithm. More...

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

void	apply_normalization_to_solution_snapshots ()
	Rescale solution snapshots so that they all have unity norm. More...

virtual Real	train_eim_approximation ()
	Generate the EIM approximation for the specified parametrized function using either POD or the Greedy Algorithm. More...

virtual Real	train_eim_approximation_with_greedy ()
	Generate the EIM approximation for the specified parametrized function using the Greedy Algorithm. More...

virtual Real	train_eim_approximation_with_POD ()
	Generate the EIM approximation for the specified parametrized function using Proper Orthogonal Decomposition (POD). More...

virtual void	initialize_eim_assembly_objects ()
	Build a vector of ElemAssembly objects that accesses the basis functions stored in this RBEIMConstruction object. More...

std::vector< std::unique_ptr< ElemAssembly > > &	get_eim_assembly_objects ()

virtual void	init_context (FEMContext &)
	Pre-request FE data needed for calculations. More...

void	set_rel_training_tolerance (Real new_training_tolerance)
	Get/set the relative tolerance for the basis training. More...

Real	get_rel_training_tolerance ()

void	set_abs_training_tolerance (Real new_training_tolerance)
	Get/set the absolute tolerance for the basis training. More...

Real	get_abs_training_tolerance ()

unsigned int	get_Nmax () const
	Get/set Nmax, the maximum number of RB functions we are willing to compute. More...

virtual void	set_Nmax (unsigned int Nmax)

void	enable_set_Nmax_from_n_snapshots (int increment)
	Call this method to set _set_Nmax_from_n_snapshots=true and _Nmax_from_n_snapshots_increment=increment. More...

void	disable_set_Nmax_from_n_snapshots ()
	Call this method to set _set_Nmax_from_n_snapshots=false and reset _Nmax_from_n_snapshots_increment to 0. More...

Real	get_max_abs_value_in_training_set () const
	Get the maximum value (across all processors) from the parametrized functions in the training set. More...

void	store_eim_solutions_for_training_set ()
	Get the EIM solution vector at all parametrized functions in the training set. More...

const QpDataMap &	get_parametrized_function_from_training_set (unsigned int training_index) const
	Get a const reference to the specified parametrized function from the training set. More...

const SideQpDataMap &	get_side_parametrized_function_from_training_set (unsigned int training_index) const

const NodeDataMap &	get_node_parametrized_function_from_training_set (unsigned int training_index) const

const std::unordered_map< dof_id_type, std::vector< Real > > &	get_local_quad_point_JxW ()
	Get the interior and side quadrature weights. More...

const std::map< std::pair< dof_id_type, unsigned int >, std::vector< Real > > &	get_local_side_quad_point_JxW ()

unsigned int	get_n_parametrized_functions_for_training () const
	Get the number of parametrized functions used for training. More...

void	reinit_eim_projection_matrix ()
	Zero the _eim_projection_matrix and resize it to be get_Nmax() x get_Nmax(). 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...

void	set_normalize_solution_snapshots (bool value)
	Set the boolean option that indicates if we normalization solution snapshots or not. More...

numeric_index_type	get_n_training_samples () const
	Get the number of global 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, const unsigned int n_global_training_samples, const std::map< std::string, bool > &log_param_scale, const 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 (const std::map< std::string, std::vector< RBParameter >> &new_training_set)
	Overwrite the training parameters with new_training_set. More...

void	set_training_parameter_values (const std::string &param_name, const std::vector< RBParameter > &values)
	Overwrite the local training samples for `param_name` using `values`. More...

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

void	set_training_random_seed (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	init ()
	Initializes degrees of freedom on the current mesh. More...

virtual void	reinit ()
	Reinitializes degrees of freedom and other required data on the current mesh. More...

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

virtual void	reinit_mesh ()
	Reinitializes the system with a new mesh. More...

bool	is_initialized () const

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

virtual void	assemble ()
	Prepares `matrix` and `_dof_map` for matrix assembly. 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 void	solve ()
	Solves the system. 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

virtual std::string	system_type () const

void	project_solution (FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) const
	Projects arbitrary functions onto the current solution. More...

void	project_solution (FEMFunctionBase< Number > f, FEMFunctionBase< Gradient > g=nullptr, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) const
	Projects arbitrary functions onto the current solution. More...

void	project_solution (ValueFunctionPointer fptr, GradientFunctionPointer gptr, const Parameters &parameters, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) const
	This method projects an arbitrary function onto the solution via L2 projections and nodal interpolations on each element. More...

void	project_vector (NumericVector< Number > &new_vector, FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr, int is_adjoint=-1, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) 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, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) 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, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) 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, std::optional< ConstElemRange > active_local_range=std::nullopt)
	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, std::optional< ConstElemRange > active_local_range=std::nullopt)
	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, std::optional< ConstElemRange > active_local_range=std::nullopt) 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, std::optional< ConstElemRange > active_local_range=std::nullopt) 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...

matrices_iterator	matrices_begin ()
	Beginning of matrices container. More...

const_matrices_iterator	matrices_begin () const
	Beginning of matrices container. More...

matrices_iterator	matrices_end ()
	End of matrices container. More...

const_matrices_iterator	matrices_end () const
	End of matrices container. More...

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

void	remove_vector (std::string_view 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 (std::string_view vec_name) const

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

NumericVector< Number > *	request_vector (std::string_view 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 (std::string_view vec_name) const

NumericVector< Number > &	get_vector (std::string_view 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 (std::string_view 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 (std::string_view 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_matrices () 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 (std::string_view 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 (std::string_view var, const Order order=FIRST, const FEFamily=LAGRANGE, const std::set< subdomain_id_type > *const active_subdomains=nullptr, const bool p_refinement=true)
	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 variables `vars` 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, const bool p_refinement=true)
	Adds the variable `var` to the list of variables for this system. More...

unsigned int	add_variable_array (const std::vector< std::string > &vars, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
	Adds variables `vars` 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 (std::string_view var) const

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

unsigned int	variable_number (std::string_view 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 (std::string_view 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 (std::string_view 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, std::string_view 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...

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, std::string_view 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...

bool	has_constraint_object () const

Constraint &	get_constraint_object ()
	Return the 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...

void	init_qois (unsigned int n_qois)
	Accessors for qoi and qoi_error_estimates vectors. More...

void	set_qoi (unsigned int qoi_index, Number qoi_value)

void	set_qoi (std::vector< Number > new_qoi)

Number	get_qoi_value (unsigned int qoi_index) const

std::vector< Number >	get_qoi_values () const
	Returns a copy of qoi, not a reference. More...

void	set_qoi_error_estimate (unsigned int qoi_index, Number qoi_error_estimate)

Number	get_qoi_error_estimate_value (unsigned int qoi_index) const

Number	point_value (unsigned int var, const Point &p, const bool insist_on_success=true, const NumericVector< Number > *sol=nullptr) const

Number	point_value (unsigned int var, const Point &p, const Elem &e, const NumericVector< Number > *sol=nullptr) 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...

Number	point_value (unsigned int var, const Point &p, const NumericVector< Number > *sol) const
	Calls the parallel version of point_value(). More...

Gradient	point_gradient (unsigned int var, const Point &p, const bool insist_on_success=true, const NumericVector< Number > *sol=nullptr) const

Gradient	point_gradient (unsigned int var, const Point &p, const Elem &e, const NumericVector< Number > *sol=nullptr) 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...

Gradient	point_gradient (unsigned int var, const Point &p, const NumericVector< Number > *sol) const
	Calls the parallel version of point_gradient(). More...

Tensor	point_hessian (unsigned int var, const Point &p, const bool insist_on_success=true, const NumericVector< Number > *sol=nullptr) const

Tensor	point_hessian (unsigned int var, const Point &p, const Elem &e, const NumericVector< Number > *sol=nullptr) 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...

Tensor	point_hessian (unsigned int var, const Point &p, const NumericVector< Number > *sol) const
	Calls the parallel version of point_hessian(). 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	get_project_with_constraints ()
	Setter and getter functions for project_with_constraints boolean. More...

void	set_project_with_constraints (bool _project_with_constraints)

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

SparseMatrix< Number > &	add_matrix (std::string_view mat_name, ParallelType type=PARALLEL, MatrixBuildType mat_build_type=MatrixBuildType::AUTOMATIC)
	Adds the additional matrix `mat_name` to this system. More...

template<template< typename > class>
SparseMatrix< Number > &	add_matrix (std::string_view mat_name, ParallelType=PARALLEL)
	Adds the additional matrix `mat_name` to this system. More...

SparseMatrix< Number > &	add_matrix (std::string_view mat_name, std::unique_ptr< SparseMatrix< Number >> matrix, ParallelType type=PARALLEL)
	Adds the additional matrix `mat_name` to this system. More...

void	remove_matrix (std::string_view mat_name)
	Removes the additional matrix `mat_name` from this system. More...

bool	have_matrix (std::string_view mat_name) const

const SparseMatrix< Number > *	request_matrix (std::string_view mat_name) const

SparseMatrix< Number > *	request_matrix (std::string_view mat_name)

const SparseMatrix< Number > &	get_matrix (std::string_view mat_name) const

SparseMatrix< Number > &	get_matrix (std::string_view mat_name)

void	prefer_hash_table_matrix_assembly (bool preference)
	Sets whether to use hash table matrix assembly if the matrix sub-classes support it. More...

void	prefix_with_name (bool value)
	Instructs this system to prefix solve options with its name for solvers that leverage prefixes. More...

bool	prefix_with_name () const

std::string	prefix () const

virtual void	create_static_condensation ()
	Request that static condensation be performed for this system. More...

bool	has_static_condensation () const

void	solve_for_unconstrained_dofs (NumericVector< Number > &, int is_adjoint=-1) const

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

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

bool	set_parameters (const RBParameters &params)
	Set the current parameters to `params` The parameters are checked for validity; an error is thrown if the number of parameters or samples is different than expected. 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 void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

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

static std::pair< std::size_t, std::size_t >	generate_training_parameters_random (const Parallel::Communicator &communicator, const std::map< std::string, bool > &log_param_scale, std::map< std::string, std::vector< RBParameter >> &local_training_parameters_in, const unsigned int n_global_training_samples_in, const RBParameters &min_parameters, const RBParameters &max_parameters, const int training_parameters_random_seed=-1, const bool serial_training_set=false)
	Static helper function for generating a randomized set of parameters. More...

static std::pair< std::size_t, std::size_t >	generate_training_parameters_deterministic (const Parallel::Communicator &communicator, const std::map< std::string, bool > &log_param_scale, std::map< std::string, std::vector< RBParameter >> &local_training_parameters_in, const unsigned int n_global_training_samples_in, const RBParameters &min_parameters, const RBParameters &max_parameters, const bool serial_training_set=false)
	Static helper function for generating a deterministic set of parameters. More...

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 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
BEST_FIT_TYPE	best_fit_type_flag
	Enum that indicates which type of "best fit" algorithm we should use. More...

Parameters	parameters
	Parameters for the system. If a parameter is not provided, it should be retrieved from the EquationSystems. 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...

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
bool	enrich_eim_approximation_on_sides (const SideQpDataMap &side_pf, bool add_basis_function, EimPointData *eim_point_data)
	Implementation of enrich_eim_approximation() for the case of element sides. More...

bool	enrich_eim_approximation_on_nodes (const NodeDataMap &node_pf, bool add_basis_function, EimPointData *eim_point_data)
	Implementation of enrich_eim_approximation() for the case of element nodes. More...

bool	enrich_eim_approximation_on_interiors (const QpDataMap &interior_pf, bool add_basis_function, EimPointData *eim_point_data)
	Implementation of enrich_eim_approximation() for the case of element interiors. More...

void	update_eim_matrices (bool set_eim_error_indicator)
	Update the matrices used in training the EIM approximation. More...

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

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

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

void	project_vector (NumericVector< Number > &, int is_adjoint=-1, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) 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, std::optional< ConstElemRange > active_local_range=std::nullopt, std::optional< std::vector< unsigned int >> variable_numbers=std::nullopt) const
	Projects the vector defined on the old mesh onto the new mesh. More...

virtual void	add_matrices ()
	Insertion point for adding matrices in derived classes before init_matrices() is called. More...

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

bool	can_add_matrices () const

virtual bool	condense_constrained_dofs () const
	Whether this object should condense out constrained degrees of freedom. More...

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

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

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

void	increment_destructor_count (const std::string &name) noexcept
	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...

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

bool	_normalize_solution_snapshots
	Set this boolean to true if we want to normalize solution snapshots used in training to have norm of 1. 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 = true
	Flag to control whether reference count information is printed when print_info is called. More...

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

Detailed Description

Definition at line 41 of file eim_classes.h.

Member Typedef Documentation

◆ const_matrices_iterator

typedef std::map<std::string, std::unique_ptr<SparseMatrix<Number> >, std::less<> >::const_iterator libMesh::System::const_matrices_iterator

inherited

Definition at line 830 of file system.h.

◆ const_vectors_iterator

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

inherited

Definition at line 804 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 119 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 119 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 555 of file system.h.

◆ matrices_iterator

typedef std::map<std::string, std::unique_ptr<SparseMatrix<Number> >, std::less<> >::iterator libMesh::System::matrices_iterator

inherited

Matrix iterator typedefs.

Definition at line 829 of file system.h.

◆ NodeDataMap

typedef RBEIMEvaluation::NodeDataMap libMesh::RBEIMConstruction::NodeDataMap

inherited

Type of the data structure used to map from node id -> [n_vars] data.

Definition at line 105 of file rb_eim_construction.h.

◆ QpDataMap

typedef RBEIMEvaluation::QpDataMap libMesh::RBEIMConstruction::QpDataMap

inherited

Type of the data structure used to map from (elem id) -> [n_vars][n_qp] data.

Definition at line 95 of file rb_eim_construction.h.

◆ SideQpDataMap

typedef RBEIMEvaluation::SideQpDataMap libMesh::RBEIMConstruction::SideQpDataMap

inherited

Type of the data structure used to map from (elem id,side_index) -> [n_vars][n_qp] data.

Definition at line 100 of file rb_eim_construction.h.

◆ sys_type

typedef RBConstructionBase<System > libMesh::RBConstructionBase< System >::sys_type

inherited

The type of system.

Definition at line 82 of file rb_construction_base.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 551 of file system.h.

◆ vectors_iterator

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

inherited

Vector iterator typedefs.

Definition at line 803 of file system.h.

Member Enumeration Documentation

◆ BEST_FIT_TYPE

enum libMesh::RBEIMConstruction::BEST_FIT_TYPE

inherited

Enumerator
PROJECTION_BEST_FIT
EIM_BEST_FIT
POD_BEST_FIT

Definition at line 71 of file rb_eim_construction.h.

71 { PROJECTION_BEST_FIT, EIM_BEST_FIT, POD_BEST_FIT };

libMesh::RBEIMConstruction::POD_BEST_FIT

Definition: rb_eim_construction.h:71

libMesh::RBEIMConstruction::PROJECTION_BEST_FIT

Definition: rb_eim_construction.h:71

libMesh::RBEIMConstruction::EIM_BEST_FIT

Definition: rb_eim_construction.h:71

Constructor & Destructor Documentation

◆ SimpleEIMConstruction() [1/2]

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

inline

Constructor.

Definition at line 48 of file eim_classes.h.

     : RBEIMConstruction(es, name_in, number_in)
   {
   }

◆ SimpleEIMConstruction() [2/2]

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

inline

Constructor.

Definition at line 46 of file eim_classes.h.

     : RBEIMConstruction(es, name_in, number_in)
   {
   }

Member Function Documentation

◆ activate()

void libMesh::System::activate ( )

inlineinherited

Activates the system.

Only active systems are solved.

Definition at line 2441 of file system.h.

References libMesh::System::_active.

 {
   _active = true;
 }

◆ active()

bool libMesh::System::active ( ) const

inlineinherited

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

Definition at line 2433 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.

Definition at line 1284 of file system.C.

References libMesh::System::add_vector().

Referenced by libMesh::ExplicitSystem::assemble_qoi_derivative(), and libMesh::FEMSystem::assemble_qoi_derivative().

 {
   std::ostringstream adjoint_rhs_name;
   adjoint_rhs_name << "adjoint_rhs" << i;
 
   return this->add_vector(adjoint_rhs_name.str(), false);
 }

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

Definition at line 1220 of file system.C.

References libMesh::System::add_vector(), and libMesh::System::set_vector_as_adjoint().

Referenced by libMesh::ImplicitSystem::adjoint_solve().

 {
   std::ostringstream adjoint_name;
   adjoint_name << "adjoint_solution" << i;
 
   NumericVector<Number> & returnval = this->add_vector(adjoint_name.str());
   this->set_vector_as_adjoint(adjoint_name.str(), i);
   return returnval;
 }

◆ add_matrices()

virtual void libMesh::System::add_matrices ( )

inlineprotectedvirtualinherited

Insertion point for adding matrices in derived classes before init_matrices() is called.

Reimplemented in libMesh::EigenSystem, libMesh::ImplicitSystem, and libMesh::CondensedEigenSystem.

Definition at line 2017 of file system.h.

Referenced by libMesh::ImplicitSystem::add_matrices(), libMesh::EigenSystem::add_matrices(), and libMesh::System::init_data().

2017 {}

◆ add_matrix() [1/3]

SparseMatrix< Number > & libMesh::System::add_matrix	(	std::string_view	mat_name,
		ParallelType	type = `PARALLEL`,
		MatrixBuildType	mat_build_type = `MatrixBuildType::AUTOMATIC`
	)

inherited

Adds the additional matrix mat_name to this system.

Only allowed prior to assemble(). All additional matrices have the same sparsity pattern as the matrix used during solution. When not System but the user wants to initialize the main/system matrix, then all the additional matrices, if existent, have to be initialized by the user, too.

This non-template method will add a derived matrix type corresponding to the solver package. If the user wishes to specify the matrix type to add, use the templated add_matrix method instead

Parameters

mat_name	A name for the matrix
type	The serial/parallel/ghosted type of the matrix
mat_build_type	The matrix type to build

Definition at line 998 of file system.C.

References libMesh::System::_matrices, libMesh::System::_matrix_types, libMesh::SparseMatrix< T >::build(), libMesh::ParallelObject::comm(), libMesh::default_solver_package(), libMesh::DIAGONAL, libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::DofMap::get_static_condensation(), libMesh::System::has_static_condensation(), libMesh::if(), libMesh::System::late_matrix_init(), and libMesh::libmesh_assert().

Referenced by libMesh::ImplicitSystem::add_matrices(), libMesh::EigenSystem::add_matrices(), alternative_fe_assembly(), libMesh::ClawSystem::assemble_boundary_condition_matrices(), libMesh::ImplicitSystem::create_static_condensation_system_matrix(), form_matrixA(), libMesh::EigenTimeSolver::init(), main(), and libMesh::NewmarkSystem::NewmarkSystem().

 {
   parallel_object_only();
 
   libmesh_assert(this->comm().verify(std::string(mat_name)));
   libmesh_assert(this->comm().verify(int(type)));
   libmesh_assert(this->comm().verify(int(mat_build_type)));
 
   // Return the matrix if it is already there.
   if (auto it = this->_matrices.find(mat_name);
       it != this->_matrices.end())
     return *it->second;
 
   // Otherwise build the matrix to return.
   std::unique_ptr<SparseMatrix<Number>> matrix;
   if (this->has_static_condensation())
     {
       if (mat_build_type == MatrixBuildType::DIAGONAL)
         libmesh_error_msg(
             "We do not currently support static condensation of the diagonal matrix type");
       matrix = std::make_unique<StaticCondensation>(this->get_mesh(),
                                                     *this,
                                                     this->get_dof_map(),
                                                     this->get_dof_map().get_static_condensation());
     }
   else
     matrix = SparseMatrix<Number>::build(this->comm(), libMesh::default_solver_package());
   auto & mat = *matrix;
 
   _matrices.emplace(mat_name, std::move(matrix));
 
   _matrix_types.emplace(mat_name, type);
 
   // Initialize it first if we've already initialized the others.
   this->late_matrix_init(mat, type);
 
   return mat;
 }

◆ add_matrix() [2/3]

template<template< typename > class MatrixType>

SparseMatrix< Number > & libMesh::System::add_matrix	(	std::string_view	mat_name,
		ParallelType	type = `PARALLEL`
	)

inlineinherited

Adds the additional matrix mat_name to this system.

Only allowed prior to assemble(). All additional matrices have the same sparsity pattern as the matrix used during solution. When not System but the user wants to initialize the main/system matrix, then all the additional matrices, if existent, have to be initialized by the user, too.

This method will create add a derived matrix of type MatrixType<Number>. One can use the non-templated add_matrix method to add a matrix corresponding to the default solver package

Parameters

mat_name	A name for the matrix
type	The serial/parallel/ghosted type of the matrix

Definition at line 2646 of file system.h.

References libMesh::System::_matrices, libMesh::System::_matrix_types, and libMesh::System::late_matrix_init().

 {
   // Return the matrix if it is already there.
   auto it = this->_matrices.find(mat_name);
   if (it != this->_matrices.end())
     return *it->second;
 
   // Otherwise build the matrix to return.
   auto pr = _matrices.emplace(mat_name, std::make_unique<MatrixType<Number>>(this->comm()));
   _matrix_types.emplace(mat_name, type);
 
   SparseMatrix<Number> & mat = *(pr.first->second);
 
   // Initialize it first if we've already initialized the others.
   this->late_matrix_init(mat, type);
 
   return mat;
 }

◆ add_matrix() [3/3]

SparseMatrix< Number > & libMesh::System::add_matrix	(	std::string_view	mat_name,
		std::unique_ptr< SparseMatrix< Number >>	matrix,
		ParallelType	type = `PARALLEL`
	)

inherited

Adds the additional matrix mat_name to this system.

Only allowed prior to assemble(). All additional matrices have the same sparsity pattern as the matrix used during solution. When not System but the user wants to initialize the main/system matrix, then all the additional matrices, if existent, have to be initialized by the user, too.

Parameters

mat_name	A name for the matrix
matrix	The matrix we are handing over the `System` for ownership
type	The serial/parallel/ghosted type of the matrix

Definition at line 1041 of file system.C.

References libMesh::System::_matrices, libMesh::System::_matrix_types, libMesh::ParallelObject::comm(), libMesh::System::late_matrix_init(), and libMesh::libmesh_assert().

 {
   parallel_object_only();
 
   const std::string namestr{mat_name};
 
   libmesh_assert(this->comm().verify(namestr));
   libmesh_assert(this->comm().verify(int(type)));
 
   SparseMatrix<Number> & mat = *matrix;
 
   _matrices[namestr] = std::move(matrix);
   _matrix_types[namestr] = type;
 
   // Initialize it first if we've already initialized the others.
   this->late_matrix_init(mat, type);
 
   return mat;
 }

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

Definition at line 1314 of file system.C.

References libMesh::System::add_vector().

Referenced by libMesh::ImplicitSystem::assemble_residual_derivatives().

 {
   std::ostringstream sensitivity_rhs_name;
   sensitivity_rhs_name << "sensitivity_rhs" << i;
 
   return this->add_vector(sensitivity_rhs_name.str(), false);
 }

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

Definition at line 1169 of file system.C.

References libMesh::System::add_vector().

Referenced by libMesh::ImplicitSystem::sensitivity_solve().

 {
   std::ostringstream sensitivity_name;
   sensitivity_name << "sensitivity_solution" << i;
 
   return this->add_vector(sensitivity_name.str());
 }

◆ add_variable() [1/2]

unsigned int libMesh::System::add_variable	(	std::string_view	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.

If active_subdomains is either nullptr (the default) or points to an empty set, then it will be assumed that var has no subdomain restrictions

Returns: The index number for the new variable.

Definition at line 1344 of file system.C.

References libMesh::DofMap::add_variable(), and libMesh::System::get_dof_map().

 {
   return this->get_dof_map().add_variable(*this, var, type, active_subdomains);
 }

◆ add_variable() [2/2]

unsigned int libMesh::System::add_variable	(	std::string_view	var,
		const Order	order = `FIRST`,
		const FEFamily	family = `LAGRANGE`,
		const std::set< subdomain_id_type > *const	active_subdomains = `nullptr`,
		const bool	p_refinement = `true`
	)

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. If active_subdomains is either nullptr (the default) or points to an empty set, then it will be assumed that var has no subdomain restrictions. If p_refinement is false, then even when on an Elem with non-zero p_level() this variable will not be p-refined.

Definition at line 1353 of file system.C.

References libMesh::System::add_variable().

 {
   return this->add_variable(var,
                             FEType(order, family).set_p_refinement(p_refinement),
                             active_subdomains);
 }

◆ add_variable_array()

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

inherited

Adds variables vars to the list of variables for this system.

If active_subdomains is either nullptr (the default) or points to an empty set, then it will be assumed that the vars have no subdomain restrictions. This API will end up calling this->add_variables(). However, we will additionally store data that can be leveraged by the DofMap to build degrees of freedom containers corresponding to all the variables in this variable array

An 'array variable' is simply a sequence of contiguous variable numbers defined by pair where the first member of the pair is the first number in the variable sequence and the second member of the pair is the number of the last variable in the sequence plus one. Array variables may be used in tandem with variable grouping by downstream code to build optimized physics kernels since each variable in the array will have the same shape functions.

Returns: The index number for the last of the new variables.

Definition at line 1386 of file system.C.

References libMesh::DofMap::add_variable_array(), and libMesh::System::get_dof_map().

Referenced by DofMapTest::testArrayDofIndicesWithType().

 {
   return this->get_dof_map().add_variable_array(*this, vars, type, active_subdomains);
 }

◆ 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 variables vars to the list of variables for this system.

If active_subdomains is either nullptr (the default) or points to an empty set, then it will be assumed that the vars have no subdomain restrictions

Returns: The index number for the last of the new variables.

Definition at line 1366 of file system.C.

References libMesh::DofMap::add_variables(), and libMesh::System::get_dof_map().

Referenced by libMesh::System::add_variables(), and SystemsTest::test100KVariables().

 {
   return this->get_dof_map().add_variables(*this, vars, type, active_subdomains);
 }

◆ add_variables() [2/2]

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

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. If active_subdomains is either nullptr (the default) or points to an empty set, then it will be assumed that var has no subdomain restrictions. If p_refinement is false, then even when on an Elem with non-zero p_level() this variable will not be p-refined.

Definition at line 1375 of file system.C.

References libMesh::System::add_variables().

 {
   return this->add_variables(vars,
                              FEType(order, family).set_p_refinement(p_refinement),
                              active_subdomains);
 }

◆ add_vector()

NumericVector< Number > & libMesh::System::add_vector	(	std::string_view	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

If the vector already exists, the existing vector is returned. after any upgrade to the projections or type has been made. We only handle upgrades (projections false->true, or type PARALLEL->GHOSTED) in this fashion, not downgrades, on the theory that if two codes have differing needs we want to support the union of those needs, not the intersection. Downgrades can only be accomplished manually, via set_vector_preservation() or by setting a vector type() and re-initializing.

Definition at line 756 of file system.C.

References libMesh::System::_dof_map, libMesh::System::_is_initialized, libMesh::System::_vector_is_adjoint, libMesh::System::_vector_projections, libMesh::System::_vectors, libMesh::NumericVector< T >::build(), libMesh::NumericVector< T >::close(), libMesh::NumericVector< T >::closed(), libMesh::ParallelObject::comm(), libMesh::default_solver_package(), libMesh::GHOSTED, libMesh::NumericVector< T >::initialized(), libMesh::libmesh_assert(), libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), libMesh::ParallelObject::n_processors(), libMesh::PARALLEL, libMesh::SERIAL, libMesh::NumericVector< T >::set_type(), libMesh::NumericVector< T >::swap(), and libMesh::NumericVector< T >::type().

Referenced by libMesh::System::add_adjoint_rhs(), libMesh::System::add_adjoint_solution(), libMesh::System::add_sensitivity_rhs(), libMesh::System::add_sensitivity_solution(), libMesh::ExplicitSystem::add_system_rhs(), libMesh::System::add_weighted_sensitivity_adjoint_solution(), libMesh::System::add_weighted_sensitivity_solution(), alternative_fe_assembly(), libMesh::AdjointRefinementEstimator::estimate_error(), fe_assembly(), form_functionA(), form_functionB(), libMesh::SecondOrderUnsteadySolver::init(), libMesh::UnsteadySolver::init(), libMesh::UnsteadySolver::init_adjoints(), libMesh::TimeSolver::init_adjoints(), libMesh::OptimizationSystem::init_data(), libMesh::ContinuationSystem::init_data(), main(), libMesh::NewmarkSystem::NewmarkSystem(), libMesh::System::read_header(), libMesh::FrequencySystem::set_frequencies(), libMesh::FrequencySystem::set_frequencies_by_range(), libMesh::FrequencySystem::set_frequencies_by_steps(), SystemsTest::testAddVectorProjChange(), SystemsTest::testAddVectorTypeChange(), SystemsTest::testPostInitAddVector(), and SystemsTest::testPostInitAddVectorTypeChange().

 {
   parallel_object_only();
 
   libmesh_assert(this->comm().verify(std::string(vec_name)));
   libmesh_assert(this->comm().verify(int(type)));
   libmesh_assert(this->comm().verify(projections));
 
   // Return the vector if it is already there.
   if (auto it = this->_vectors.find(vec_name);
       it != this->_vectors.end())
     {
       // If the projection setting has *upgraded*, change it.
       if (projections) // only do expensive lookup if needed
         libmesh_map_find(_vector_projections, vec_name) = projections;
 
       NumericVector<Number> & vec = *it->second;
 
       // If we're in serial, our vectors are effectively SERIAL, so
       // we'll ignore any type setting.  If we're in parallel, we
       // might have a type change to deal with.
 
       if (this->n_processors() > 1)
         {
           // If the type setting has changed in a way we can't
           // perceive as an upgrade or a downgrade, scream.
           libmesh_assert_equal_to(type == SERIAL,
                                   vec.type() == SERIAL);
 
           // If the type setting has *upgraded*, change it.
           if (type == GHOSTED && vec.type() == PARALLEL)
             {
               // A *really* late upgrade is expensive, but better not
               // to risk zeroing data.
               if (vec.initialized())
                 {
                   if (!vec.closed())
                     vec.close();
 
                   // Ideally we'd move parallel coefficients and then
                   // add ghosted coefficients, but copy and swap is
                   // simpler.  If anyone actually ever uses this case
                   // for real we can look into optimizing it.
                   auto new_vec = NumericVector<Number>::build(this->comm());
 #ifdef LIBMESH_ENABLE_GHOSTED
                   new_vec->init (this->n_dofs(), this->n_local_dofs(),
                                  _dof_map->get_send_list(), /*fast=*/false,
                                  GHOSTED);
 #else
                   libmesh_error_msg("Cannot initialize ghosted vectors when they are not enabled.");
 #endif
 
                   *new_vec = vec;
                   vec.swap(*new_vec);
                 }
               else
                 // The PARALLEL vec is not yet initialized, so we can
                 // just "upgrade" it to GHOSTED.
                 vec.set_type(type);
             }
         }
 
       // Any upgrades are done; we're happy here.
       return vec;
     }
 
   // Otherwise, build the vector. The following emplace() is
   // guaranteed to succeed because, if we made it here, we don't
   // already have a vector named "vec_name". We pass the user's
   // requested ParallelType directly to NumericVector::build() so
   // that, even if the vector is not initialized now, it will get the
   // right type when it is initialized later.
   auto pr =
     _vectors.emplace(vec_name,
                      NumericVector<Number>::build(this->comm(),
                                                   libMesh::default_solver_package(),
                                                   type));
   auto buf = pr.first->second.get();
   _vector_projections.emplace(vec_name, projections);
 
   // Vectors are primal by default
   _vector_is_adjoint.emplace(vec_name, -1);
 
   // Initialize it if necessary
   if (_is_initialized)
     {
       if (type == GHOSTED)
         {
 #ifdef LIBMESH_ENABLE_GHOSTED
           buf->init (this->n_dofs(), this->n_local_dofs(),
                      _dof_map->get_send_list(), /*fast=*/false,
                      GHOSTED);
 #else
           libmesh_error_msg("Cannot initialize ghosted vectors when they are not enabled.");
 #endif
         }
       else
         buf->init (this->n_dofs(), this->n_local_dofs(), false, type);
     }
 
   return *buf;
 }

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

Definition at line 1252 of file system.C.

References libMesh::System::add_vector(), and libMesh::System::set_vector_as_adjoint().

Referenced by libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

 {
   std::ostringstream adjoint_name;
   adjoint_name << "weighted_sensitivity_adjoint_solution" << i;
 
   NumericVector<Number> & returnval = this->add_vector(adjoint_name.str());
   this->set_vector_as_adjoint(adjoint_name.str(), i);
   return returnval;
 }

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

Definition at line 1199 of file system.C.

References libMesh::System::add_vector().

Referenced by libMesh::ImplicitSystem::weighted_sensitivity_solve().

 {
   return this->add_vector("weighted_sensitivity_solution");
 }

◆ adjoint_qoi_parameter_sensitivity()

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

inlinevirtualinherited

Solves for parameter sensitivities using the adjoint method.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2602 of file system.h.

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

 {
   libmesh_not_implemented();
 }

◆ adjoint_solve()

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

inlinevirtualinherited

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 2586 of file system.h.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), and libMesh::AdjointResidualErrorEstimator::estimate_error().

 {
   libmesh_not_implemented();
 }

◆ apply_normalization_to_solution_snapshots()

void libMesh::RBEIMConstruction::apply_normalization_to_solution_snapshots ( )

inherited

Rescale solution snapshots so that they all have unity norm.

This is relevant if training samples have differing magnitudes and we want to approximate them all with equal accuracy.

Definition at line 639 of file rb_eim_construction.C.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation().

 {
   LOG_SCOPE("apply_normalization_to_solution_snapshots()", "RBEIMConstruction");
 
   libMesh::out << "Normalizing solution snapshots" << std::endl;
 
   bool apply_comp_scaling = !get_rb_eim_evaluation().scale_components_in_enrichment().empty();
   unsigned int n_snapshots = get_n_training_samples();
   RBEIMEvaluation & rbe = get_rb_eim_evaluation();
 
   for (unsigned int i=0; i<n_snapshots; i++)
     {
       Real norm_val = 0.;
       if (rbe.get_parametrized_function().on_mesh_sides())
         {
           norm_val = std::sqrt(std::real(side_inner_product(
             _local_side_parametrized_functions_for_training[i],
             _local_side_parametrized_functions_for_training[i],
             apply_comp_scaling)));
 
           if (norm_val > 0.)
             scale_parametrized_function(_local_side_parametrized_functions_for_training[i], 1./norm_val);
         }
       else if (rbe.get_parametrized_function().on_mesh_nodes())
         {
           norm_val = std::sqrt(std::real(node_inner_product(
             _local_node_parametrized_functions_for_training[i],
             _local_node_parametrized_functions_for_training[i],
             apply_comp_scaling)));
 
           if (norm_val > 0.)
             scale_node_parametrized_function(_local_node_parametrized_functions_for_training[i], 1./norm_val);
         }
       else
         {
           norm_val = std::sqrt(std::real(inner_product(
             _local_parametrized_functions_for_training[i],
             _local_parametrized_functions_for_training[i],
             apply_comp_scaling)));
 
           if (norm_val > 0.)
             scale_parametrized_function(_local_parametrized_functions_for_training[i], 1./norm_val);
         }
 
       // Since we're rescaling the training samples, we should also rescale
       // _max_abs_value_in_training_set in the same way. We obtained the
       // _max_abs_value_in_training_set value from the sample with index
       // _max_abs_value_in_training_set_index, so we rescale using the norm
       // of this sample here. Note that the value we obtain may not be exactly
       // equal to the max value we would obtain after looping over all the
       // normalized samples, because we normalized in the L2 norm rather than
       // in the max norm, but it should be close to this "true max" value. The
       // main use-case of _max_abs_value_in_training_set is to scale the relative
       // error tolerance in the Greedy training, and the L2-norm-scaled value of
       // _max_abs_value_in_training_set that we obtain here should be sufficient
       // for that purpose.
       if ((i == _max_abs_value_in_training_set_index) && (norm_val > 0.))
         _max_abs_value_in_training_set /= norm_val;
     }
 
   libMesh::out << "Maximum absolute value in the training set after normalization: "
     << _max_abs_value_in_training_set << std::endl << std::endl;
 }

◆ assemble()

void libMesh::System::assemble ( )

virtualinherited

Prepares matrix and _dof_map for matrix assembly.

Does not actually assemble anything. For matrix assembly, use the assemble() in derived classes. Should be overridden in derived classes.

Reimplemented in libMesh::LinearImplicitSystem, libMesh::DifferentiableSystem, libMesh::ImplicitSystem, libMesh::FrequencySystem, and libMesh::NewmarkSystem.

Definition at line 554 of file system.C.

References libMesh::System::user_assembly().

Referenced by libMesh::ImplicitSystem::assemble(), libMesh::EigenSystem::solve(), libMesh::CondensedEigenSystem::solve(), and libMesh::ExplicitSystem::solve().

 {
   // Log how long the user's assembly code takes
   LOG_SCOPE("assemble()", "System");
 
   // Call the user-specified assembly function
   this->user_assembly();
 }

◆ assemble_qoi()

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.

Definition at line 565 of file system.C.

References libMesh::System::user_QOI().

Referenced by libMesh::ExplicitSystem::assemble_qoi().

 {
   // Log how long the user's assembly code takes
   LOG_SCOPE("assemble_qoi()", "System");
 
   // Call the user-specified quantity of interest function
   this->user_QOI(qoi_indices);
 }

◆ assemble_qoi_derivative()

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.

Definition at line 576 of file system.C.

References libMesh::System::user_QOI_derivative().

Referenced by libMesh::ExplicitSystem::assemble_qoi_derivative().

 {
   // Log how long the user's assembly code takes
   LOG_SCOPE("assemble_qoi_derivative()", "System");
 
   // Call the user-specified quantity of interest function
   this->user_QOI_derivative(qoi_indices, include_liftfunc,
                             apply_constraints);
 }

◆ assemble_residual_derivatives()

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

inlinevirtualinherited

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

Definition at line 1959 of file system.C.

References libMesh::System::_assemble_system_function, libMesh::System::_assemble_system_object, fptr(), and libMesh::libmesh_assert().

Referenced by assemble_and_solve(), main(), ConstraintOperatorTest::test1DCoarseningNewNodes(), ConstraintOperatorTest::test1DCoarseningOperator(), SystemsTest::testAssemblyWithDgFemContext(), ConstraintOperatorTest::testCoreform(), SystemsTest::testDofCouplingWithVarGroups(), PeriodicBCTest::testPeriodicBC(), DisjointNeighborTest::testTempJump(), and DisjointNeighborTest::testTempJumpRefine().

 {
   libmesh_assert(fptr);
 
   if (_assemble_system_object != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both assembly function and object!");
 
       _assemble_system_object = nullptr;
     }
 
   _assemble_system_function = fptr;
 }

◆ attach_assemble_object()

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

inherited

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

Definition at line 1976 of file system.C.

References libMesh::System::_assemble_system_function, and libMesh::System::_assemble_system_object.

Referenced by main().

 {
   if (_assemble_system_function != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both assembly object and function!");
 
       _assemble_system_function = nullptr;
     }
 
   _assemble_system_object = &assemble_in;
 }

◆ attach_constraint_function()

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

inherited

Register a user function for imposing constraints.

Definition at line 1990 of file system.C.

References libMesh::System::_constrain_system_function, libMesh::System::_constrain_system_object, fptr(), and libMesh::libmesh_assert().

 {
   libmesh_assert(fptr);
 
   if (_constrain_system_object != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both constraint function and object!");
 
       _constrain_system_object = nullptr;
     }
 
   _constrain_system_function = fptr;
 }

◆ attach_constraint_object()

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

inherited

Register a user object for imposing constraints.

Definition at line 2007 of file system.C.

References libMesh::System::_constrain_system_function, and libMesh::System::_constrain_system_object.

Referenced by libMesh::VariationalMeshSmoother::setup(), and DofMapTest::testConstraintLoopDetection().

 {
   if (_constrain_system_function != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both constraint object and function!");
 
       _constrain_system_function = nullptr;
     }
 
   _constrain_system_object = &constrain;
 }

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

Definition at line 1928 of file system.C.

References libMesh::System::_init_system_function, libMesh::System::_init_system_object, fptr(), and libMesh::libmesh_assert().

Referenced by main().

 {
   libmesh_assert(fptr);
 
   if (_init_system_object != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both initialization function and object!");
 
       _init_system_object = nullptr;
     }
 
   _init_system_function = fptr;
 }

◆ attach_init_object()

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

inherited

Register a user class to use to initialize the system.

Note: This is exclusive with the attach_init_function.

Definition at line 1945 of file system.C.

References libMesh::System::_init_system_function, and libMesh::System::_init_system_object.

 {
   if (_init_system_function != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both initialization object and function!");
 
       _init_system_function = nullptr;
     }
 
   _init_system_object = &init_in;
 }

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

Definition at line 2064 of file system.C.

References libMesh::System::_qoi_evaluate_derivative_function, libMesh::System::_qoi_evaluate_derivative_object, fptr(), and libMesh::libmesh_assert().

 {
   libmesh_assert(fptr);
 
   if (_qoi_evaluate_derivative_object != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both QOI derivative function and object!");
 
       _qoi_evaluate_derivative_object = nullptr;
     }
 
   _qoi_evaluate_derivative_function = fptr;
 }

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

Definition at line 2081 of file system.C.

References libMesh::System::_qoi_evaluate_derivative_function, and libMesh::System::_qoi_evaluate_derivative_object.

 {
   if (_qoi_evaluate_derivative_function != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both QOI derivative object and function!");
 
       _qoi_evaluate_derivative_function = nullptr;
     }
 
   _qoi_evaluate_derivative_object = &qoi_derivative;
 }

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

Definition at line 2032 of file system.C.

References libMesh::System::_qoi_evaluate_function, libMesh::System::_qoi_evaluate_object, fptr(), and libMesh::libmesh_assert().

 {
   libmesh_assert(fptr);
 
   if (_qoi_evaluate_object != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both QOI function and object!");
 
       _qoi_evaluate_object = nullptr;
     }
 
   _qoi_evaluate_function = fptr;
 }

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

Definition at line 2050 of file system.C.

References libMesh::System::_qoi_evaluate_function, and libMesh::System::_qoi_evaluate_object.

 {
   if (_qoi_evaluate_function != nullptr)
     {
       libmesh_warning("WARNING:  Cannot specify both QOI object and function!");
 
       _qoi_evaluate_function = nullptr;
     }
 
   _qoi_evaluate_object = &qoi_in;
 }

◆ 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`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`
	)

inherited

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

This method projects an arbitrary boundary function onto the solution via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection.

Definition at line 1305 of file system_projection.C.

References b.

Referenced by SystemsTest::testBoundaryProjectCube().

 {
   this->boundary_project_vector(b, variables, *solution, f, g, -1 /*is_adjoint*/, active_local_range);
 
   solution->localize(*current_local_solution);
 }

◆ 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,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`
	)

inherited

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

This method projects components of an arbitrary boundary function onto the solution via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection.

Definition at line 1286 of file system_projection.C.

References b, fptr(), and gptr().

 {
   WrappedFunction<Number> f(*this, fptr, &function_parameters);
   WrappedFunction<Gradient> g(*this, gptr, &function_parameters);
   this->boundary_project_solution(b, variables, &f, &g, active_local_range);
 }

◆ 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`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`
	)		const

inherited

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

This method projects an arbitrary function via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection.

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

Definition at line 1343 of file system_projection.C.

References b, libMesh::NumericVector< T >::close(), libMesh::libmesh_ignore(), and libMesh::Threads::parallel_for().

 {
   LOG_SCOPE ("boundary_project_vector()", "System");
 
   if (!active_local_range)
   {
     active_local_range.emplace
       (this->get_mesh().active_local_elements_begin(),
        this->get_mesh().active_local_elements_end());
   }
 
   Threads::parallel_for
     (active_local_range.value(),
      BoundaryProjectSolution(b, variables, *this, f, g,
                              this->get_equation_systems().parameters,
                              new_vector)
      );
 
   // We don't do SCALAR dofs when just projecting the boundary, so
   // we're done here.
 
   new_vector.close();
 
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
   if (is_adjoint == -1)
     this->get_dof_map().enforce_constraints_exactly(*this, &new_vector);
   else if (is_adjoint >= 0)
     this->get_dof_map().enforce_adjoint_constraints_exactly(new_vector,
                                                             is_adjoint);
 #else
   libmesh_ignore(is_adjoint);
 #endif
 }

◆ 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`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`
	)		const

inherited

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

This method projects an arbitrary boundary function via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection.

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

Definition at line 1324 of file system_projection.C.

References b, fptr(), and gptr().

 {
   WrappedFunction<Number> f(*this, fptr, &function_parameters);
   WrappedFunction<Gradient> g(*this, gptr, &function_parameters);
   this->boundary_project_vector(b, variables, new_vector, &f, &g,
                                 is_adjoint, active_local_range);
 }

◆ broadcast_parameters()

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

inherited

Broadcasts parameters from processor proc_id to all processors.

This broadcasts the RBParameters object from .get_parameters(), and then sets it on all processors with .set_parameters().

Definition at line 720 of file rb_construction_base.C.

 {
   libmesh_assert_less (proc_id, this->n_processors());
 
   // create a copy of the current parameters
   RBParameters current_parameters = get_parameters();
   libmesh_error_msg_if(current_parameters.n_samples()!=1,
       "Only single-sample RBParameter objects can be broadcast.");
 
   // Serialize the current_parameters to current_parameters_vector in order to broadcast.
   // We handle multiple samples and vector values.
   // However, the vector values are assumed to remain the same size across samples.
   const std::size_t nparams = current_parameters.n_parameters();
   const std::size_t nsamples = current_parameters.n_samples();
 
   // First we get the sizes of all the parameter value vectors.
   std::vector<std::size_t> param_value_sizes;
   param_value_sizes.reserve(nparams);
   for (const auto & pr : current_parameters)
     param_value_sizes.push_back(pr.second[0].size());
 
   // Broadcast the sizes vector and reserve memory.
   this->comm().broadcast(param_value_sizes, proc_id);
   std::size_t buffsize = std::accumulate(param_value_sizes.cbegin(), param_value_sizes.cend(), 0ul);
   std::vector<Real> serialized_parameters;
   serialized_parameters.reserve(buffsize);
 
   // Then we serialize the parameters/sample/value vectors into a single vector.
   for (const auto & pr : current_parameters)
     {
       for (const auto sample_idx : make_range(nsamples))
         serialized_parameters.insert(serialized_parameters.end(),
                                      pr.second[sample_idx].cbegin(),
                                      pr.second[sample_idx].cend());
     }
 
   // Do the broadcasts.
   this->comm().broadcast(serialized_parameters, proc_id);
 
   // Deserialize into the copy of the RBParameters object.
   std::size_t param_idx = 0;
   auto val_idx = serialized_parameters.cbegin();
   for (const auto & pr : current_parameters)
     {
       const std::size_t param_value_size = param_value_sizes[param_idx];
       for (const auto sample_idx: make_range(nsamples))
         {
           auto end_val_idx = std::next(val_idx,param_value_size);
           RBParameter sample_val(val_idx, end_val_idx);
           current_parameters.set_value(pr.first, sample_idx, sample_val);
           val_idx = end_val_idx;
         }
       ++param_idx;
     }
 
   // Overwrite the parameters globally.
   set_parameters(current_parameters);
 }

◆ build_eim_assembly() [1/2]

virtual std::unique_ptr<ElemAssembly> SimpleEIMConstruction::build_eim_assembly ( unsigned int index )

inlinevirtual

Provide an implementation of build_eim_assembly.

Implements libMesh::RBEIMConstruction.

Definition at line 56 of file eim_classes.h.

   {
     return std::make_unique<AssemblyEIM>(*this, index);
   }

◆ build_eim_assembly() [2/2]

virtual std::unique_ptr<ElemAssembly> SimpleEIMConstruction::build_eim_assembly ( unsigned int index )

inlinevirtual

Provide an implementation of build_eim_assembly.

Implements libMesh::RBEIMConstruction.

Definition at line 68 of file eim_classes.h.

   {
     return std::make_unique<EIM_F>(*this, index);
   }

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

Definition at line 1511 of file system.C.

References libMesh::DISCRETE_L1, libMesh::DISCRETE_L2, libMesh::DISCRETE_L_INF, libMesh::System::discrete_var_norm(), libMesh::L2, libMesh::System::n_vars(), and libMesh::Real.

Referenced by libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::AdaptiveTimeSolver::calculate_norm(), libMesh::UnsteadySolver::du(), main(), output_norms(), ConstraintOperatorTest::testCoreform(), and MeshInputTest::testProjectionRegression().

 {
   //short circuit to save time
   if (norm_type == DISCRETE_L1 ||
       norm_type == DISCRETE_L2 ||
       norm_type == DISCRETE_L_INF)
     return discrete_var_norm(v,var,norm_type);
 
   // Not a discrete norm
   std::vector<FEMNormType> norms(this->n_vars(), L2);
   std::vector<Real> weights(this->n_vars(), 0.0);
   norms[var] = norm_type;
   weights[var] = 1.0;
   Real val = this->calculate_norm(v, SystemNorm(norms, weights), skip_dimensions);
   return val;
 }

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

Definition at line 1533 of file system.C.

References libMesh::System::_dof_map, libMesh::System::_mesh, libMesh::FEGenericBase< OutputType >::build(), libMesh::NumericVector< T >::build(), libMesh::ParallelObject::comm(), libMesh::FEType::default_quadrature_rule(), dim, libMesh::DISCRETE_L1, libMesh::DISCRETE_L2, libMesh::DISCRETE_L_INF, libMesh::System::discrete_var_norm(), libMesh::DofMap::dof_indices(), libMesh::MeshBase::elem_dimensions(), libMesh::Utility::enum_to_string(), libMesh::FEInterface::field_type(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::GHOSTED, libMesh::H1, libMesh::H1_SEMINORM, libMesh::H2, libMesh::H2_SEMINORM, libMesh::L1, libMesh::NumericVector< T >::l1_norm(), libMesh::L2, libMesh::NumericVector< T >::l2_norm(), libMesh::L_INF, libMesh::libmesh_assert(), libMesh::NumericVector< T >::linfty_norm(), libMesh::NumericVector< T >::local_size(), libMesh::NumericVector< T >::localize(), libMesh::make_range(), TIMPI::Communicator::max(), libMesh::System::n_vars(), libMesh::TensorTools::norm(), libMesh::TensorTools::norm_sq(), libMesh::Real, libMesh::NumericVector< T >::size(), TIMPI::Communicator::sum(), libMesh::TYPE_SCALAR, libMesh::TYPE_VECTOR, libMesh::DofMap::variable_type(), libMesh::W1_INF_SEMINORM, libMesh::W2_INF_SEMINORM, and libMesh::SystemNorm::weight().

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   LOG_SCOPE ("calculate_norm()", "System");
 
   // Zero the norm before summation
   Real v_norm = 0.;
 
   if (norm.is_discrete())
     {
       //Check to see if all weights are 1.0 and all types are equal
       FEMNormType norm_type0 = norm.type(0);
       unsigned int check_var = 0, check_end = this->n_vars();
       for (; check_var != check_end; ++check_var)
         if ((norm.weight(check_var) != 1.0) || (norm.type(check_var) != norm_type0))
           break;
 
       //All weights were 1.0 so just do the full vector discrete norm
       if (check_var == this->n_vars())
         {
           if (norm_type0 == DISCRETE_L1)
             return v.l1_norm();
           if (norm_type0 == DISCRETE_L2)
             return v.l2_norm();
           if (norm_type0 == DISCRETE_L_INF)
             return v.linfty_norm();
           else
             libmesh_error_msg("Invalid norm_type0 = " << Utility::enum_to_string(norm_type0));
         }
 
       for (auto var : make_range(this->n_vars()))
         {
           // Skip any variables we don't need to integrate
           if (norm.weight(var) == 0.0)
             continue;
 
           v_norm += norm.weight(var) * discrete_var_norm(v, var, norm.type(var));
         }
 
       return v_norm;
     }
 
   // Localize the potentially parallel vector
   std::unique_ptr<NumericVector<Number>> local_v = NumericVector<Number>::build(this->comm());
   local_v->init(v.size(), v.local_size(), _dof_map->get_send_list(),
                 true, GHOSTED);
   v.localize (*local_v, _dof_map->get_send_list());
 
   // I'm not sure how best to mix Hilbert norms on some variables (for
   // which we'll want to square then sum then square root) with norms
   // like L_inf (for which we'll just want to take an absolute value
   // and then sum).
   bool using_hilbert_norm = true,
     using_nonhilbert_norm = true;
 
   // Loop over all variables
   for (auto var : make_range(this->n_vars()))
     {
       // Skip any variables we don't need to integrate
       Real norm_weight_sq = norm.weight_sq(var);
       if (norm_weight_sq == 0.0)
         continue;
       Real norm_weight = norm.weight(var);
 
       // Check for unimplemented norms (rather than just returning 0).
       FEMNormType norm_type = norm.type(var);
       if ((norm_type==H1) ||
           (norm_type==H2) ||
           (norm_type==L2) ||
           (norm_type==H1_SEMINORM) ||
           (norm_type==H2_SEMINORM))
         {
           if (!using_hilbert_norm)
             libmesh_not_implemented();
           using_nonhilbert_norm = false;
         }
       else if ((norm_type==L1) ||
                (norm_type==L_INF) ||
                (norm_type==W1_INF_SEMINORM) ||
                (norm_type==W2_INF_SEMINORM))
         {
           if (!using_nonhilbert_norm)
             libmesh_not_implemented();
           using_hilbert_norm = false;
         }
       else
         libmesh_not_implemented();
 
       const FEType & fe_type = this->get_dof_map().variable_type(var);
 
       // Allow space for dims 0-3, and for both scalar and vector
       // elements, even if we don't use them all
       std::vector<std::unique_ptr<FEBase>> fe_ptrs(4);
       std::vector<std::unique_ptr<FEVectorBase>> vec_fe_ptrs(4);
       std::vector<std::unique_ptr<QBase>> q_rules(4);
 
       const std::set<unsigned char> & elem_dims = _mesh.elem_dimensions();
 
       // Prepare finite elements for each dimension present in the mesh
       for (const auto & dim : elem_dims)
         {
           if (skip_dimensions && skip_dimensions->find(dim) != skip_dimensions->end())
             continue;
 
           // Construct quadrature and finite element objects
           q_rules[dim] = fe_type.default_quadrature_rule (dim);
 
           const FEFieldType field_type = FEInterface::field_type(fe_type);
           if (field_type == TYPE_SCALAR)
             {
               fe_ptrs[dim] = FEBase::build(dim, fe_type);
               fe_ptrs[dim]->attach_quadrature_rule (q_rules[dim].get());
             }
           else
             {
               vec_fe_ptrs[dim] = FEVectorBase::build(dim, fe_type);
               vec_fe_ptrs[dim]->attach_quadrature_rule (q_rules[dim].get());
               libmesh_assert_equal_to(field_type, TYPE_VECTOR);
             }
 
         }
 
       std::vector<dof_id_type> dof_indices;
 
       // Begin the loop over the elements
       for (const auto & elem : this->get_mesh().active_local_element_ptr_range())
         {
           const unsigned int dim = elem->dim();
 
           // One way for implementing this would be to exchange the fe with the FEInterface- class.
           // However, it needs to be discussed whether integral-norms make sense for infinite elements.
           // or in which sense they could make sense.
           if (elem->infinite() )
             libmesh_not_implemented();
 
           if (skip_dimensions && skip_dimensions->find(dim) != skip_dimensions->end())
             continue;
 
           QBase * qrule = q_rules[dim].get();
           libmesh_assert(qrule);
 
           this->get_dof_map().dof_indices (elem, dof_indices, var);
 
           auto element_calculation = [&dof_indices, &elem,
                norm_type, norm_weight, norm_weight_sq, &qrule,
                &local_v, &v_norm](auto & fe) {
           typedef typename std::remove_reference<decltype(fe)>::type::OutputShape OutputShape;
           typedef typename TensorTools::MakeNumber<OutputShape>::type OutputNumberShape;
           typedef typename std::remove_reference<decltype(fe)>::type::OutputGradient OutputGradient;
           typedef typename TensorTools::MakeNumber<OutputGradient>::type OutputNumberGradient;
 
           const std::vector<Real> &                     JxW = fe.get_JxW();
           const std::vector<std::vector<OutputShape>> * phi = nullptr;
           if (norm_type == H1 ||
               norm_type == H2 ||
               norm_type == L2 ||
               norm_type == L1 ||
               norm_type == L_INF)
             phi = &(fe.get_phi());
 
           const std::vector<std::vector<OutputGradient>> * dphi = nullptr;
           if (norm_type == H1 ||
               norm_type == H2 ||
               norm_type == H1_SEMINORM ||
               norm_type == W1_INF_SEMINORM)
             dphi = &(fe.get_dphi());
 
 #ifdef LIBMESH_ENABLE_SECOND_DERIVATIVES
           typedef typename std::remove_reference<decltype(fe)>::type::OutputTensor OutputTensor;
 
           const std::vector<std::vector<OutputTensor>> *  d2phi = nullptr;
           if (norm_type == H2 ||
               norm_type == H2_SEMINORM ||
               norm_type == W2_INF_SEMINORM)
             d2phi = &(fe.get_d2phi());
 #endif
 
           fe.reinit (elem);
 
           const unsigned int n_qp = qrule->n_points();
 
           const unsigned int n_sf = cast_int<unsigned int>
             (dof_indices.size());
 
           // Begin the loop over the Quadrature points.
           for (unsigned int qp=0; qp<n_qp; qp++)
             {
               if (norm_type == L1)
                 {
                   OutputNumberShape u_h = 0.;
                   for (unsigned int i=0; i != n_sf; ++i)
                     u_h += (*phi)[i][qp] * (*local_v)(dof_indices[i]);
                   v_norm += norm_weight *
                     JxW[qp] * TensorTools::norm(u_h);
                 }
 
               if (norm_type == L_INF)
                 {
                   OutputNumberShape u_h = 0.;
                   for (unsigned int i=0; i != n_sf; ++i)
                     u_h += (*phi)[i][qp] * (*local_v)(dof_indices[i]);
                   v_norm = std::max(v_norm, norm_weight * TensorTools::norm(u_h));
                 }
 
               if (norm_type == H1 ||
                   norm_type == H2 ||
                   norm_type == L2)
                 {
                   OutputNumberShape u_h = 0.;
                   for (unsigned int i=0; i != n_sf; ++i)
                     u_h += (*phi)[i][qp] * (*local_v)(dof_indices[i]);
                   v_norm += norm_weight_sq *
                     JxW[qp] * TensorTools::norm_sq(u_h);
                 }
 
               if (norm_type == H1 ||
                   norm_type == H2 ||
                   norm_type == H1_SEMINORM)
                 {
                   OutputNumberGradient grad_u_h;
                   for (unsigned int i=0; i != n_sf; ++i)
                     grad_u_h.add_scaled((*dphi)[i][qp], (*local_v)(dof_indices[i]));
                   v_norm += norm_weight_sq *
                     JxW[qp] * grad_u_h.norm_sq();
                 }
 
               if (norm_type == W1_INF_SEMINORM)
                 {
                   OutputNumberGradient grad_u_h;
                   for (unsigned int i=0; i != n_sf; ++i)
                     grad_u_h.add_scaled((*dphi)[i][qp], (*local_v)(dof_indices[i]));
                   v_norm = std::max(v_norm, norm_weight * grad_u_h.norm());
                 }
 
 #ifdef LIBMESH_ENABLE_SECOND_DERIVATIVES
               typedef typename TensorTools::MakeNumber<OutputTensor>::type OutputNumberTensor;
 
               if (norm_type == H2 ||
                   norm_type == H2_SEMINORM)
                 {
                   OutputNumberTensor hess_u_h;
                   for (unsigned int i=0; i != n_sf; ++i)
                     hess_u_h.add_scaled((*d2phi)[i][qp], (*local_v)(dof_indices[i]));
                   v_norm += norm_weight_sq *
                     JxW[qp] * hess_u_h.norm_sq();
                 }
 
               if (norm_type == W2_INF_SEMINORM)
                 {
                   OutputNumberTensor hess_u_h;
                   for (unsigned int i=0; i != n_sf; ++i)
                     hess_u_h.add_scaled((*d2phi)[i][qp], (*local_v)(dof_indices[i]));
                   v_norm = std::max(v_norm, norm_weight * hess_u_h.norm());
                 }
 #endif
             }
           };
 
           FEBase * scalar_fe = fe_ptrs[dim].get();
           FEVectorBase * vec_fe = vec_fe_ptrs[dim].get();
 
           if (scalar_fe)
             {
               libmesh_assert(!vec_fe);
               element_calculation(*scalar_fe);
             }
 
           if (vec_fe)
             {
               libmesh_assert(!scalar_fe);
               element_calculation(*vec_fe);
             }
         }
     }
 
   if (using_hilbert_norm)
     {
       this->comm().sum(v_norm);
       v_norm = std::sqrt(v_norm);
     }
   else
     {
       this->comm().max(v_norm);
     }
 
   return v_norm;
 }

◆ can_add_matrices()

bool libMesh::System::can_add_matrices ( ) const

inlineprotectedinherited

Returns: Whether or not matrices can still be added without expensive per-matrix initialization.

Definition at line 2028 of file system.h.

References libMesh::System::_matrices_initialized.

Referenced by libMesh::EigenSystem::set_eigenproblem_type().

2028 { return !_matrices_initialized; }

libMesh::System::_matrices_initialized

bool _matrices_initialized

false when additional matrices being added require initialization, true otherwise.

Definition: system.h:2287

◆ clear()

void libMesh::RBEIMConstruction::clear ( )

overridevirtualinherited

Clear this object.

Reimplemented from libMesh::RBConstructionBase< System >.

Definition at line 127 of file rb_eim_construction.C.

 {
   RBConstructionBase::clear();
 
   _rb_eim_assembly_objects.clear();
 
   _local_parametrized_functions_for_training.clear();
   _local_quad_point_locations.clear();
   _local_quad_point_JxW.clear();
   _local_quad_point_subdomain_ids.clear();
 
   _local_side_parametrized_functions_for_training.clear();
   _local_side_quad_point_locations.clear();
   _local_side_quad_point_JxW.clear();
   _local_side_quad_point_subdomain_ids.clear();
   _local_side_quad_point_boundary_ids.clear();
   _local_side_quad_point_side_types.clear();
 
   _local_node_parametrized_functions_for_training.clear();
   _local_node_locations.clear();
   _local_node_boundary_ids.clear();
 
   _eim_projection_matrix.resize(0,0);
 }

◆ comm()

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

inlineinherited

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

Definition at line 97 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

98 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:120

◆ compare()

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.

Definition at line 606 of file system.C.

References libMesh::System::_is_initialized, libMesh::System::_sys_name, libMesh::System::_vectors, libMesh::System::get_vector(), libMesh::libmesh_assert(), libMesh::System::n_vectors(), libMesh::System::name(), libMesh::out, and libMesh::System::solution.

 {
   // we do not care for matrices, but for vectors
   libmesh_assert (_is_initialized);
   libmesh_assert (other_system._is_initialized);
 
   if (verbose)
     {
       libMesh::out << "  Systems \"" << _sys_name << "\"" << std::endl;
       libMesh::out << "   comparing matrices not supported." << std::endl;
       libMesh::out << "   comparing names...";
     }
 
   // compare the name: 0 means identical
   const int name_result = _sys_name.compare(other_system.name());
   if (verbose)
     {
       if (name_result == 0)
         libMesh::out << " identical." << std::endl;
       else
         libMesh::out << "  names not identical." << std::endl;
       libMesh::out << "   comparing solution vector...";
     }
 
 
   // compare the solution: -1 means identical
   const int solu_result = solution->compare (*other_system.solution.get(),
                                              threshold);
 
   if (verbose)
     {
       if (solu_result == -1)
         libMesh::out << " identical up to threshold." << std::endl;
       else
         libMesh::out << "  first difference occurred at index = "
                      << solu_result << "." << std::endl;
     }
 
 
   // safety check, whether we handle at least the same number
   // of vectors
   std::vector<int> ov_result;
 
   if (this->n_vectors() != other_system.n_vectors())
     {
       if (verbose)
         {
           libMesh::out << "   Fatal difference. This system handles "
                        << this->n_vectors() << " add'l vectors," << std::endl
                        << "   while the other system handles "
                        << other_system.n_vectors()
                        << " add'l vectors." << std::endl
                        << "   Aborting comparison." << std::endl;
         }
       return false;
     }
   else if (this->n_vectors() == 0)
     {
       // there are no additional vectors...
       ov_result.clear ();
     }
   else
     {
       // compare other vectors
       for (auto & [vec_name, vec] : _vectors)
         {
           if (verbose)
             libMesh::out << "   comparing vector \""
                          << vec_name << "\" ...";
 
           // assume they have the same name
           const NumericVector<Number> & other_system_vector =
             other_system.get_vector(vec_name);
 
           ov_result.push_back(vec->compare(other_system_vector, threshold));
 
           if (verbose)
             {
               if (ov_result[ov_result.size()-1] == -1)
                 libMesh::out << " identical up to threshold." << std::endl;
               else
                 libMesh::out << " first difference occurred at" << std::endl
                              << "   index = " << ov_result[ov_result.size()-1] << "." << std::endl;
             }
         }
     } // finished comparing additional vectors
 
 
   bool overall_result;
 
   // sum up the results
   if ((name_result==0) && (solu_result==-1))
     {
       if (ov_result.size()==0)
         overall_result = true;
       else
         {
           bool ov_identical;
           unsigned int n    = 0;
           do
             {
               ov_identical = (ov_result[n]==-1);
               n++;
             }
           while (ov_identical && n<ov_result.size());
           overall_result = ov_identical;
         }
     }
   else
     overall_result = false;
 
   if (verbose)
     {
       libMesh::out << "   finished comparisons, ";
       if (overall_result)
         libMesh::out << "found no differences." << std::endl << std::endl;
       else
         libMesh::out << "found differences." << std::endl << std::endl;
     }
 
   return overall_result;
 }

◆ condense_constrained_dofs()

virtual bool libMesh::System::condense_constrained_dofs ( ) const

inlineprotectedvirtualinherited

Whether this object should condense out constrained degrees of freedom.

Reimplemented in libMesh::CondensedEigenSystem.

Definition at line 2059 of file system.h.

Referenced by libMesh::EigenSystem::init_matrices().

2059 { return false; }

◆ create_static_condensation()

void libMesh::System::create_static_condensation ( )

virtualinherited

Request that static condensation be performed for this system.

Reimplemented in libMesh::ImplicitSystem, libMesh::NonlinearImplicitSystem, and libMesh::LinearImplicitSystem.

Definition at line 2664 of file system.C.

References libMesh::DofMap::create_static_condensation(), libMesh::System::get_dof_map(), and libMesh::System::get_mesh().

Referenced by libMesh::System::clear(), libMesh::ImplicitSystem::create_static_condensation(), and libMesh::System::System().

 {
   this->get_dof_map().create_static_condensation(this->get_mesh(), *this);
 }

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

Definition at line 162 of file system.C.

References libMesh::System::_dof_map, and libMesh::System::current_local_solution.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::HPCoarsenTest::add_projection(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), libMesh::ExactErrorEstimator::estimate_error(), main(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::SmoothnessEstimator::EstimateSmoothness::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::HPCoarsenTest::select_refinement(), SolidSystem::side_time_derivative(), libMesh::EnsightIO::write_scalar_ascii(), and libMesh::EnsightIO::write_vector_ascii().

 {
   // Check the sizes
   libmesh_assert_less (global_dof_number, _dof_map->n_dofs());
   libmesh_assert_less (global_dof_number, current_local_solution->size());
 
   return (*current_local_solution)(global_dof_number);
 }

◆ deactivate()

void libMesh::System::deactivate ( )

inlineinherited

Deactivates the system.

Only active systems are solved.

Definition at line 2449 of file system.h.

References libMesh::System::_active.

 {
   _active = false;
 }

◆ disable_cache()

void libMesh::System::disable_cache ( )

inlinevirtualinherited

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 2559 of file system.h.

References libMesh::System::assemble_before_solve.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error().

2559 { 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:1609

◆ disable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = false;
   return;
 }

◆ disable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = false;
   return;
 }

◆ disable_set_Nmax_from_n_snapshots()

void libMesh::RBEIMConstruction::disable_set_Nmax_from_n_snapshots ( )

inherited

Call this method to set _set_Nmax_from_n_snapshots=false and reset _Nmax_from_n_snapshots_increment to 0.

Definition at line 1226 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_Nmax_from_n_snapshots_increment, and libMesh::RBEIMConstruction::_set_Nmax_from_n_snapshots.

 {
   _set_Nmax_from_n_snapshots = false;
   _Nmax_from_n_snapshots_increment = 0;
 }

◆ enable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Enabled by default.

Definition at line 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

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

 {
   _enable_print_counter = true;
   return;
 }

◆ enable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Enabled by default.

Definition at line 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

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

 {
   _enable_print_counter = true;
   return;
 }

◆ enable_set_Nmax_from_n_snapshots()

void libMesh::RBEIMConstruction::enable_set_Nmax_from_n_snapshots ( int increment )

inherited

Call this method to set _set_Nmax_from_n_snapshots=true and _Nmax_from_n_snapshots_increment=increment.

This means that we will overrule Nmax to be n_snapshots + increment, where increment can be positive or negative (typically it should be negative to limit Nmax to be less that the number of snapshots).

Definition at line 1220 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_Nmax_from_n_snapshots_increment, and libMesh::RBEIMConstruction::_set_Nmax_from_n_snapshots.

 {
   _set_Nmax_from_n_snapshots = true;
   _Nmax_from_n_snapshots_increment = increment;
 }

◆ enrich_eim_approximation_on_interiors()

bool libMesh::RBEIMConstruction::enrich_eim_approximation_on_interiors	(	const QpDataMap &	interior_pf,
		bool	add_basis_function,
		EimPointData *	eim_point_data
	)

protectedinherited

Implementation of enrich_eim_approximation() for the case of element interiors.

Definition at line 2677 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_component_scaling_in_training_set, libMesh::RBEIMConstruction::_local_quad_point_locations, libMesh::RBEIMConstruction::_local_quad_point_locations_perturbations, libMesh::RBEIMConstruction::_local_quad_point_subdomain_ids, libMesh::RBEIMEvaluation::add_basis_function(), libMesh::RBEIMEvaluation::add_interpolation_data(), TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::EimPointData::comp_index, libMesh::RBEIMEvaluation::decrement_vector(), dim, libMesh::Elem::dim(), libMesh::FEMContext::elem_dimensions(), libMesh::EimPointData::elem_id, libMesh::MeshBase::elem_ref(), libMesh::FEMContext::get_elem_dim(), libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), libMesh::RBEIMEvaluation::get_interpolation_points_comp(), libMesh::RBEIMEvaluation::get_interpolation_points_elem_id(), libMesh::RBEIMEvaluation::get_interpolation_points_qp(), libMesh::System::get_mesh(), libMesh::RBEIMEvaluation::get_n_basis_functions(), libMesh::QBase::get_order(), libMesh::RBParametrized::get_parameters(), libMesh::RBEIMEvaluation::get_parametrized_function(), libMesh::RBEIMEvaluation::get_parametrized_function_value(), libMesh::RBEIMConstruction::get_rb_eim_evaluation(), libMesh::index_range(), libMesh::INVALID_ELEM, libMesh::DofObject::invalid_id, libMesh::INVALID_ORDER, TIMPI::Communicator::maxloc(), libMesh::out, libMesh::FEMContext::pre_fe_reinit(), libMesh::EimPointData::qp_index, libMesh::RBEIMEvaluation::rb_eim_solve(), libMesh::Real, libMesh::Elem::reference_elem(), libMesh::RBParametrizedFunction::requires_all_elem_center_data, libMesh::RBParametrizedFunction::requires_all_elem_qp_data, libMesh::RBEIMConstruction::scale_parametrized_function(), libMesh::RBParametrized::set_parameters(), libMesh::Elem::type(), value, and libMesh::Elem::vertex_average().

Referenced by libMesh::RBEIMConstruction::enrich_eim_approximation(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   // Make a copy of the input parametrized function, since we will modify this below
   // to give us a new basis function.
   QpDataMap local_pf = interior_pf;
 
   RBEIMEvaluation & eim_eval = get_rb_eim_evaluation();
 
   // If we have at least one basis function, then we need to use
   // rb_eim_solve() to find the EIM interpolation error. Otherwise,
   // just use solution as is.
   if (!eim_point_data && (eim_eval.get_n_basis_functions() > 0))
     {
       // Get the right-hand side vector for the EIM approximation
       // by sampling the parametrized function (stored in solution)
       // at the interpolation points.
       unsigned int RB_size = eim_eval.get_n_basis_functions();
       DenseVector<Number> EIM_rhs(RB_size);
       for (unsigned int i=0; i<RB_size; i++)
         {
           EIM_rhs(i) =
             RBEIMEvaluation::get_parametrized_function_value(comm(),
                                                             local_pf,
                                                             eim_eval.get_interpolation_points_elem_id(i),
                                                             eim_eval.get_interpolation_points_comp(i),
                                                             eim_eval.get_interpolation_points_qp(i));
         }
 
       eim_eval.set_parameters( get_parameters() );
       DenseVector<Number> rb_eim_solution = eim_eval.rb_eim_solve(EIM_rhs);
 
       // Load the "EIM residual" into solution by subtracting
       // the EIM approximation
       eim_eval.decrement_vector(local_pf, rb_eim_solution);
     }
 
   // Find the quadrature point at which local_pf (which now stores
   // the "EIM residual") has maximum absolute value
   Number optimal_value = 0.;
   Point optimal_point;
   unsigned int optimal_comp = 0;
   dof_id_type optimal_elem_id = DofObject::invalid_id;
   subdomain_id_type optimal_subdomain_id = 0;
   unsigned int optimal_qp = 0;
   std::vector<Point> optimal_point_perturbs;
   std::vector<Real> optimal_point_phi_i_qp;
   ElemType optimal_elem_type = INVALID_ELEM;
   std::vector<Real> optimal_JxW_all_qp;
   std::vector<std::vector<Real>> optimal_phi_i_all_qp;
   Order optimal_qrule_order = INVALID_ORDER;
   Point optimal_dxyzdxi_elem_center;
   Point optimal_dxyzdeta_elem_center;
 
   // Initialize largest_abs_value to be negative so that it definitely gets updated.
   Real largest_abs_value = -1.;
 
   // In order to compute phi_i_qp, we initialize a FEMContext
   FEMContext con(*this);
   for (auto dim : con.elem_dimensions())
     {
       auto fe = con.get_element_fe(/*var=*/0, dim);
       fe->get_phi();
       fe->get_JxW();
       fe->get_dxyzdxi();
       fe->get_dxyzdeta();
     }
 
   for (const auto & [elem_id, comp_and_qp] : local_pf)
     {
       // Also initialize phi in order to compute phi_i_qp
       const Elem & elem_ref = get_mesh().elem_ref(elem_id);
       con.pre_fe_reinit(*this, &elem_ref);
 
       auto elem_fe = con.get_element_fe(/*var=*/0, elem_ref.dim());
       const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();
       const auto & JxW = elem_fe->get_JxW();
       const auto & dxyzdxi = elem_fe->get_dxyzdxi();
       const auto & dxyzdeta = elem_fe->get_dxyzdeta();
 
       elem_fe->reinit(&elem_ref);
 
       for (const auto & comp : index_range(comp_and_qp))
         {
           const std::vector<Number> & qp_values = comp_and_qp[comp];
 
           for (auto qp : index_range(qp_values))
             {
               Number value = qp_values[qp];
               Real abs_value = std::abs(value);
 
               if (get_rb_eim_evaluation().scale_components_in_enrichment().count(comp))
                 abs_value *= _component_scaling_in_training_set[comp];
 
               bool update_optimal_point = false;
               if (!eim_point_data)
                 update_optimal_point = (abs_value > largest_abs_value);
               else
                 update_optimal_point = (elem_id == eim_point_data->elem_id) &&
                                        (comp == eim_point_data->comp_index) &&
                                        (qp == eim_point_data->qp_index);
 
               if (update_optimal_point)
                 {
                   largest_abs_value = abs_value;
                   optimal_value = value;
                   optimal_comp = comp;
                   optimal_elem_id = elem_id;
                   optimal_qp = qp;
                   optimal_elem_type = elem_ref.type();
 
                   optimal_point_phi_i_qp.resize(phi.size());
                   for (auto i : index_range(phi))
                     optimal_point_phi_i_qp[i] = phi[i][qp];
 
                   const auto & point_list =
                     libmesh_map_find(_local_quad_point_locations, elem_id);
 
                   libmesh_error_msg_if(qp >= point_list.size(), "Error: Invalid qp");
 
                   optimal_point = point_list[qp];
 
                   optimal_subdomain_id = libmesh_map_find(_local_quad_point_subdomain_ids, elem_id);
 
                   if (get_rb_eim_evaluation().get_parametrized_function().requires_xyz_perturbations)
                     {
                       const auto & perturb_list =
                         libmesh_map_find(_local_quad_point_locations_perturbations, elem_id);
 
                       libmesh_error_msg_if(qp >= perturb_list.size(), "Error: Invalid qp");
 
                       optimal_point_perturbs = perturb_list[qp];
                     }
 
                   if (get_rb_eim_evaluation().get_parametrized_function().requires_all_elem_qp_data)
                     {
                       optimal_JxW_all_qp = JxW;
                       optimal_phi_i_all_qp = phi;
                     }
 
                   if (get_rb_eim_evaluation().get_parametrized_function().requires_all_elem_center_data)
                     {
                       optimal_qrule_order = con.get_element_qrule().get_order();
                       // Get data derivatives at vertex average
                       std::vector<Point> nodes = { elem_ref.reference_elem()->vertex_average() };
                       elem_fe->reinit (&elem_ref, &nodes);
 
                       Point dxyzdxi_pt, dxyzdeta_pt;
                       if (con.get_elem_dim()>0)
                         dxyzdxi_pt = dxyzdxi[0];
                       if (con.get_elem_dim()>1)
                         dxyzdeta_pt = dxyzdeta[0];
 
                       optimal_dxyzdxi_elem_center = dxyzdxi_pt;
                       optimal_dxyzdeta_elem_center = dxyzdeta_pt;
 
                       elem_fe->reinit(&elem_ref);
                     }
                 }
             }
         }
     }
 
   // Find out which processor has the largest of the abs values
   // and broadcast from that processor.
   unsigned int proc_ID_index;
   this->comm().maxloc(largest_abs_value, proc_ID_index);
 
   this->comm().broadcast(optimal_value, proc_ID_index);
   this->comm().broadcast(optimal_point, proc_ID_index);
   this->comm().broadcast(optimal_comp, proc_ID_index);
   this->comm().broadcast(optimal_elem_id, proc_ID_index);
   this->comm().broadcast(optimal_subdomain_id, proc_ID_index);
   this->comm().broadcast(optimal_qp, proc_ID_index);
   this->comm().broadcast(optimal_point_perturbs, proc_ID_index);
   this->comm().broadcast(optimal_point_phi_i_qp, proc_ID_index);
   this->comm().broadcast(optimal_JxW_all_qp, proc_ID_index);
   this->comm().broadcast(optimal_phi_i_all_qp, proc_ID_index);
   this->comm().broadcast(optimal_dxyzdxi_elem_center, proc_ID_index);
   this->comm().broadcast(optimal_dxyzdeta_elem_center, proc_ID_index);
 
   // Cast optimal_elem_type to an int in order to broadcast it
   {
     int optimal_elem_type_int = static_cast<int>(optimal_elem_type);
     this->comm().broadcast(optimal_elem_type_int, proc_ID_index);
     optimal_elem_type = static_cast<ElemType>(optimal_elem_type_int);
   }
 
   // Cast optimal_qrule_order to an int in order to broadcast it
   {
     int optimal_qrule_order_int = static_cast<int>(optimal_qrule_order);
     this->comm().broadcast(optimal_qrule_order_int, proc_ID_index);
     optimal_qrule_order = static_cast<Order>(optimal_qrule_order_int);
   }
 
   libmesh_error_msg_if(optimal_elem_id == DofObject::invalid_id, "Error: Invalid element ID");
 
   if (add_basis_function)
     {
       if (optimal_value == 0.)
         {
           libMesh::out << "Encountered linearly dependent data in EIM enrichment, hence skip adding new basis function" << std::endl;
           return true;
         }
 
       // Scale local_pf so that its largest value is 1.0
       scale_parametrized_function(local_pf, 1./optimal_value);
 
       // Add local_pf as the new basis function and store data
       // associated with the interpolation point.
       eim_eval.add_basis_function(local_pf);
     }
 
   eim_eval.add_interpolation_data(optimal_point,
                                   optimal_comp,
                                   optimal_elem_id,
                                   optimal_subdomain_id,
                                   optimal_qp,
                                   optimal_point_perturbs,
                                   optimal_point_phi_i_qp,
                                   optimal_elem_type,
                                   optimal_JxW_all_qp,
                                   optimal_phi_i_all_qp,
                                   optimal_qrule_order,
                                   optimal_dxyzdxi_elem_center,
                                   optimal_dxyzdeta_elem_center);
 
   // In this case we did not encounter a linearly dependent basis function, so return false
   return false;
 }

◆ enrich_eim_approximation_on_nodes()

bool libMesh::RBEIMConstruction::enrich_eim_approximation_on_nodes	(	const NodeDataMap &	node_pf,
		bool	add_basis_function,
		EimPointData *	eim_point_data
	)

protectedinherited

Implementation of enrich_eim_approximation() for the case of element nodes.

Definition at line 2563 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_node_boundary_ids, libMesh::RBEIMConstruction::_local_node_locations, libMesh::RBEIMEvaluation::add_node_basis_function(), libMesh::RBEIMEvaluation::add_node_interpolation_data(), TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::EimPointData::comp_index, libMesh::RBEIMEvaluation::get_interpolation_points_comp(), libMesh::RBEIMEvaluation::get_interpolation_points_node_id(), libMesh::RBEIMEvaluation::get_n_basis_functions(), libMesh::RBParametrized::get_parameters(), libMesh::RBEIMEvaluation::get_parametrized_function_node_value(), libMesh::RBEIMConstruction::get_rb_eim_evaluation(), libMesh::index_range(), libMesh::DofObject::invalid_id, TIMPI::Communicator::maxloc(), libMesh::RBEIMEvaluation::node_decrement_vector(), libMesh::EimPointData::node_id, libMesh::out, libMesh::RBEIMEvaluation::rb_eim_solve(), libMesh::Real, libMesh::RBEIMConstruction::scale_node_parametrized_function(), libMesh::RBParametrized::set_parameters(), and value.

Referenced by libMesh::RBEIMConstruction::enrich_eim_approximation(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   // Make a copy of the input parametrized function, since we will modify this below
   // to give us a new basis function.
   NodeDataMap local_pf = node_pf;
 
   RBEIMEvaluation & eim_eval = get_rb_eim_evaluation();
 
   // If we have at least one basis function, then we need to use
   // rb_eim_solve() to find the EIM interpolation error. Otherwise,
   // just use solution as is.
   if (!eim_point_data && (eim_eval.get_n_basis_functions() > 0))
     {
       // Get the right-hand side vector for the EIM approximation
       // by sampling the parametrized function (stored in solution)
       // at the interpolation points.
       unsigned int RB_size = eim_eval.get_n_basis_functions();
       DenseVector<Number> EIM_rhs(RB_size);
       for (unsigned int i=0; i<RB_size; i++)
         {
           EIM_rhs(i) =
             RBEIMEvaluation::get_parametrized_function_node_value(comm(),
                                                                   local_pf,
                                                                   eim_eval.get_interpolation_points_node_id(i),
                                                                   eim_eval.get_interpolation_points_comp(i));
         }
 
       eim_eval.set_parameters( get_parameters() );
       DenseVector<Number> rb_eim_solution = eim_eval.rb_eim_solve(EIM_rhs);
 
       // Load the "EIM residual" into solution by subtracting
       // the EIM approximation
       eim_eval.node_decrement_vector(local_pf, rb_eim_solution);
     }
 
   // Find the quadrature point at which local_pf (which now stores
   // the "EIM residual") has maximum absolute value
   Number optimal_value = 0.;
   Point optimal_point;
   unsigned int optimal_comp = 0;
   dof_id_type optimal_node_id = DofObject::invalid_id;
   boundary_id_type optimal_boundary_id = 0;
 
   // Initialize largest_abs_value to be negative so that it definitely gets updated.
   Real largest_abs_value = -1.;
 
   for (const auto & [node_id, values] : local_pf)
     {
       for (unsigned int comp : index_range(values))
         {
           Number value = values[comp];
           Real abs_value = std::abs(value);
 
           bool update_optimal_point = false;
           if (!eim_point_data)
             update_optimal_point = (abs_value > largest_abs_value);
           else
             update_optimal_point = (node_id == eim_point_data->node_id) &&
                                    (comp == eim_point_data->comp_index);
 
           if (update_optimal_point)
             {
               largest_abs_value = abs_value;
               optimal_value = value;
               optimal_comp = comp;
               optimal_node_id = node_id;
 
               optimal_point = libmesh_map_find(_local_node_locations, node_id);
 
               optimal_boundary_id = libmesh_map_find(_local_node_boundary_ids, node_id);
             }
         }
     }
 
   // Find out which processor has the largest of the abs values
   // and broadcast from that processor.
   unsigned int proc_ID_index;
   this->comm().maxloc(largest_abs_value, proc_ID_index);
 
   this->comm().broadcast(optimal_value, proc_ID_index);
   this->comm().broadcast(optimal_point, proc_ID_index);
   this->comm().broadcast(optimal_comp, proc_ID_index);
   this->comm().broadcast(optimal_node_id, proc_ID_index);
   this->comm().broadcast(optimal_boundary_id, proc_ID_index);
 
   libmesh_error_msg_if(optimal_node_id == DofObject::invalid_id, "Error: Invalid node ID");
 
   if (add_basis_function)
     {
       if (optimal_value == 0.)
         {
           libMesh::out << "Encountered linearly dependent data in EIM enrichment, hence skip adding new basis function" << std::endl;
           return true;
         }
 
       // Scale local_pf so that its largest value is 1.0
       scale_node_parametrized_function(local_pf, 1./optimal_value);
 
       // Add local_pf as the new basis function and store data
       // associated with the interpolation point.
       eim_eval.add_node_basis_function(local_pf);
     }
 
   eim_eval.add_node_interpolation_data(optimal_point,
                                        optimal_comp,
                                        optimal_node_id,
                                        optimal_boundary_id);
 
   // In this case we did not encounter a linearly dependent basis function, so return false
   return false;
 }

◆ enrich_eim_approximation_on_sides()

bool libMesh::RBEIMConstruction::enrich_eim_approximation_on_sides	(	const SideQpDataMap &	side_pf,
		bool	add_basis_function,
		EimPointData *	eim_point_data
	)

protectedinherited

Implementation of enrich_eim_approximation() for the case of element sides.

If add_basis_function is true, then we add an extra basis function to the EIM basis. If it is false, then we only store the data associated with the interpolation point that we identify, which can be relevant when setting up data for the error indicator, for example.

If eim_point_data is not nullptr, then we add the extra point that is specified rather than looking for the "optimal point" in interior_pf.

Returns: true if side_pf is linearly dependent to the existing basis, and in this case we skip adding the basis function since we do not want to add linearly dependent data to the basis.

Definition at line 2368 of file rb_eim_construction.C.

Referenced by libMesh::RBEIMConstruction::enrich_eim_approximation(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   // Make a copy of the input parametrized function, since we will modify this below
   // to give us a new basis function.
   SideQpDataMap local_pf = side_pf;
 
   RBEIMEvaluation & eim_eval = get_rb_eim_evaluation();
 
   // If we have at least one basis function, then we need to use
   // rb_eim_solve() to find the EIM interpolation error. Otherwise,
   // just use solution as is.
   if (!eim_point_data && (eim_eval.get_n_basis_functions() > 0))
     {
       // Get the right-hand side vector for the EIM approximation
       // by sampling the parametrized function (stored in solution)
       // at the interpolation points.
       unsigned int RB_size = eim_eval.get_n_basis_functions();
       DenseVector<Number> EIM_rhs(RB_size);
       for (unsigned int i=0; i<RB_size; i++)
         {
           EIM_rhs(i) =
             RBEIMEvaluation::get_parametrized_function_side_value(comm(),
                                                                   local_pf,
                                                                   eim_eval.get_interpolation_points_elem_id(i),
                                                                   eim_eval.get_interpolation_points_side_index(i),
                                                                   eim_eval.get_interpolation_points_comp(i),
                                                                   eim_eval.get_interpolation_points_qp(i));
         }
 
       eim_eval.set_parameters( get_parameters() );
       DenseVector<Number> rb_eim_solution = eim_eval.rb_eim_solve(EIM_rhs);
 
       // Load the "EIM residual" into solution by subtracting
       // the EIM approximation
       eim_eval.side_decrement_vector(local_pf, rb_eim_solution);
     }
 
   // Find the quadrature point at which local_pf (which now stores
   // the "EIM residual") has maximum absolute value
   Number optimal_value = 0.;
   Point optimal_point;
   unsigned int optimal_comp = 0;
   dof_id_type optimal_elem_id = DofObject::invalid_id;
   unsigned int optimal_side_index = 0;
   subdomain_id_type optimal_subdomain_id = 0;
   boundary_id_type optimal_boundary_id = 0;
   unsigned int optimal_qp = 0;
   std::vector<Point> optimal_point_perturbs;
   std::vector<Real> optimal_point_phi_i_qp;
 
   // Initialize largest_abs_value to be negative so that it definitely gets updated.
   Real largest_abs_value = -1.;
 
   // In order to compute phi_i_qp, we initialize a FEMContext
   FEMContext con(*this);
   init_context(con);
 
   for (const auto & [elem_and_side, comp_and_qp] : local_pf)
     {
       dof_id_type elem_id = elem_and_side.first;
       unsigned int side_index = elem_and_side.second;
 
       const Elem & elem_ref = get_mesh().elem_ref(elem_id);
       con.pre_fe_reinit(*this, &elem_ref);
 
       unsigned int side_type = libmesh_map_find(_local_side_quad_point_side_types, elem_and_side);
 
       std::vector<std::vector<Real>> phi;
       // side_type == 0 --> standard side
       // side_type == 1 --> shellface
       if (side_type == 0)
         {
           // TODO: We only want the "dofs on side" entries
           // from phi_side. Could do this by initing an FE object
           // on the side itself, rather than using get_side_fe().
           auto side_fe = con.get_side_fe(/*var=*/ 0);
           side_fe->reinit(&elem_ref, side_index);
 
           phi = side_fe->get_phi();
         }
       else if (side_type == 1)
         {
           con.elem_fe_reinit();
 
           auto elem_fe = con.get_element_fe(/*var=*/0, elem_ref.dim());
           phi = elem_fe->get_phi();
         }
       else
         libmesh_error_msg ("Unrecognized side_type: " << side_type);
 
       for (const auto & comp : index_range(comp_and_qp))
         {
           const std::vector<Number> & qp_values = comp_and_qp[comp];
 
           for (auto qp : index_range(qp_values))
             {
               Number value = qp_values[qp];
               Real abs_value = std::abs(value);
 
               bool update_optimal_point = false;
               if (!eim_point_data)
                 update_optimal_point = (abs_value > largest_abs_value);
               else
                 update_optimal_point = (elem_id == eim_point_data->elem_id) &&
                                        (side_index == eim_point_data->side_index) &&
                                        (comp == eim_point_data->comp_index) &&
                                        (qp == eim_point_data->qp_index);
 
               if (update_optimal_point)
                 {
                   largest_abs_value = abs_value;
                   optimal_value = value;
                   optimal_comp = comp;
                   optimal_elem_id = elem_id;
                   optimal_side_index = side_index;
                   optimal_qp = qp;
 
                   optimal_point_phi_i_qp.resize(phi.size());
                   for (auto i : index_range(phi))
                     optimal_point_phi_i_qp[i] = phi[i][qp];
 
                   const auto & point_list =
                     libmesh_map_find(_local_side_quad_point_locations, elem_and_side);
 
                   libmesh_error_msg_if(qp >= point_list.size(), "Error: Invalid qp");
 
                   optimal_point = point_list[qp];
 
                   optimal_subdomain_id = libmesh_map_find(_local_side_quad_point_subdomain_ids, elem_and_side);
                   optimal_boundary_id = libmesh_map_find(_local_side_quad_point_boundary_ids, elem_and_side);
 
                   if (get_rb_eim_evaluation().get_parametrized_function().requires_xyz_perturbations)
                     {
                       const auto & perturb_list =
                         libmesh_map_find(_local_side_quad_point_locations_perturbations, elem_and_side);
 
                       libmesh_error_msg_if(qp >= perturb_list.size(), "Error: Invalid qp");
 
                       optimal_point_perturbs = perturb_list[qp];
                     }
                 }
             }
         }
     }
 
   // Find out which processor has the largest of the abs values
   // and broadcast from that processor.
   unsigned int proc_ID_index;
   this->comm().maxloc(largest_abs_value, proc_ID_index);
 
   this->comm().broadcast(optimal_value, proc_ID_index);
   this->comm().broadcast(optimal_point, proc_ID_index);
   this->comm().broadcast(optimal_comp, proc_ID_index);
   this->comm().broadcast(optimal_elem_id, proc_ID_index);
   this->comm().broadcast(optimal_side_index, proc_ID_index);
   this->comm().broadcast(optimal_subdomain_id, proc_ID_index);
   this->comm().broadcast(optimal_boundary_id, proc_ID_index);
   this->comm().broadcast(optimal_qp, proc_ID_index);
   this->comm().broadcast(optimal_point_perturbs, proc_ID_index);
   this->comm().broadcast(optimal_point_phi_i_qp, proc_ID_index);
 
   libmesh_error_msg_if(optimal_elem_id == DofObject::invalid_id, "Error: Invalid element ID");
 
   if (add_basis_function)
     {
       if (optimal_value == 0.)
         {
           libMesh::out << "Encountered linearly dependent data in EIM enrichment, hence skip adding new basis function" << std::endl;
           return true;
         }
 
       // Scale local_pf so that its largest value is 1.0
       scale_parametrized_function(local_pf, 1./optimal_value);
 
       // Add local_pf as the new basis function and store data
       // associated with the interpolation point.
       eim_eval.add_side_basis_function(local_pf);
     }
 
   eim_eval.add_side_interpolation_data(optimal_point,
                                        optimal_comp,
                                        optimal_elem_id,
                                        optimal_side_index,
                                        optimal_subdomain_id,
                                        optimal_boundary_id,
                                        optimal_qp,
                                        optimal_point_perturbs,
                                        optimal_point_phi_i_qp);
 
   // In this case we did not encounter a linearly dependent basis function, so return false
   return false;
 }

◆ forward_qoi_parameter_sensitivity()

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

inlinevirtualinherited

Solves for parameter sensitivities using the forward method.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2611 of file system.h.

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

 {
   libmesh_not_implemented();
 }

◆ generate_training_parameters_deterministic()

std::pair< std::size_t, std::size_t > libMesh::RBConstructionBase< System >::generate_training_parameters_deterministic	(	const Parallel::Communicator &	communicator,
		const std::map< std::string, bool > &	log_param_scale,
		std::map< std::string, std::vector< RBParameter >> &	local_training_parameters_in,
		const unsigned int	n_global_training_samples_in,
		const RBParameters &	min_parameters,
		const RBParameters &	max_parameters,
		const bool	serial_training_set = `false`
	)

staticinherited

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. The parameter n_global_training_samples_in is the total number of parameters to generate, and they will be split across all the processors (unless serial_training_set=true) in the local_training_parameters_in map.

Returns: a pair of {first_local_index,last_local_index}

Definition at line 572 of file rb_construction_base.C.

 {
   libmesh_assert_equal_to ( min_parameters.n_parameters(), max_parameters.n_parameters() );
   const unsigned int num_params = min_parameters.n_parameters();
 
   if (num_params == 0)
     return {0,0};
 
   if (num_params > 3)
     libmesh_not_implemented_msg("ERROR: Deterministic training sample generation "
                                 "not implemented for more than three parameters.");
 
   // TODO - we don't support vector-data here yet. This would only apply in the case where
   //        min or max are vector-valued, and all the generated points need to stay within those ranges.
   //        But typically we expect that if we're calling this function, we only have 1 min and 1 max,
   //        so the generated values are single-valued as well. The .get_value() calls will throw an error
   //        if this is not the case.
 
   // Reinitialize training_parameters_in (but don't remove existing keys!)
   const auto &[n_local_training_samples, first_local_index] =
       calculate_n_local_samples_and_index(communicator, n_global_training_samples_in,
                                          serial_training_set);
   const auto last_local_index = first_local_index + n_local_training_samples;
   for (const auto & pr : min_parameters)
     local_training_parameters_in[pr.first] = std::vector<RBParameter>(n_local_training_samples);
 
   // n_training_samples_per_param has 3 entries, but entries after "num_params"
   // are unused so we just set their value to 1. We need to set it to 1 (rather
   // than 0) so that we don't skip the inner part of the triply-nested loop over
   // n_training_samples_per_param below.
   std::vector<unsigned int> n_training_samples_per_param(3);
   for (unsigned int param=0; param<3; param++)
     {
       if (param < num_params)
         {
           n_training_samples_per_param[param] =
             static_cast<unsigned int>( std::round(std::pow(static_cast<Real>(n_global_training_samples_in), 1./num_params)) );
         }
       else
         {
           n_training_samples_per_param[param] = 1;
         }
     }
 
   {
     // The current implementation assumes that we have the same number of
     // samples in each parameter, so we check that n_training_samples_in
     // is consistent with this assumption.
     unsigned int total_samples_check = 1;
     for (unsigned int n_samples : n_training_samples_per_param)
       {
         total_samples_check *= n_samples;
       }
 
     libmesh_error_msg_if(total_samples_check != n_global_training_samples_in,
                          "Error: Number of training samples = "
                          << n_global_training_samples_in
                          << " does not enable a uniform grid of samples with "
                          << num_params << " parameters. Try "
                          << total_samples_check << " samples instead?");
   }
 
   // First we make a list of training samples associated with each parameter,
   // then we take a tensor product to obtain the final set of training samples.
   std::vector<std::vector<Real>> training_samples_per_param(num_params);
   {
     unsigned int i = 0;
     for (const auto & pr : min_parameters)
       {
         const std::string & param_name = pr.first;
         const bool use_log_scaling = libmesh_map_find(log_param_scale, param_name);
         Real min_param = min_parameters.get_value(param_name);
         Real max_param = max_parameters.get_value(param_name);
 
         training_samples_per_param[i].resize(n_training_samples_per_param[i]);
 
         for (unsigned int j=0; j<n_training_samples_per_param[i]; j++)
           {
             // Generate log10 scaled training parameters
             if (use_log_scaling)
               {
                 Real epsilon = 1.e-6; // Prevent rounding errors triggering asserts
                 Real log_min   = std::log10(min_param + epsilon);
                 Real log_range = std::log10( (max_param-epsilon) / (min_param+epsilon) );
                 Real step_size = log_range /
                   std::max((unsigned int)1,(n_training_samples_per_param[i]-1));
 
                 if (j<(n_training_samples_per_param[i]-1))
                   {
                     training_samples_per_param[i][j] = std::pow(10., log_min + j*step_size );
                   }
                 else
                   {
                     // due to rounding error, the last parameter can be slightly
                     // bigger than max_parameters, hence snap back to the max
                     training_samples_per_param[i][j] = max_param;
                   }
               }
             else
               {
                 // Generate linearly scaled training parameters
                 Real step_size = (max_param - min_param) /
                   std::max((unsigned int)1,(n_training_samples_per_param[i]-1));
                 training_samples_per_param[i][j] = j*step_size + min_param;
               }
 
           }
         i++;
       }
   }
 
   // Now load into training_samples_in
   {
     std::vector<unsigned int> indices(3);
     unsigned int index_count = 0;
     for (indices[0]=0; indices[0]<n_training_samples_per_param[0]; indices[0]++)
       {
         for (indices[1]=0; indices[1]<n_training_samples_per_param[1]; indices[1]++)
           {
             for (indices[2]=0; indices[2]<n_training_samples_per_param[2]; indices[2]++)
               {
                 unsigned int param_count = 0;
                 for (const auto & pr : min_parameters)
                   {
                     std::vector<RBParameter> & training_vector =
                       libmesh_map_find(local_training_parameters_in, pr.first);
                     if (first_local_index <= index_count && index_count < last_local_index)
                       training_vector[index_count - first_local_index] =
                         {training_samples_per_param[param_count][indices[param_count]]};
 
                     param_count++;
                   }
                 index_count++;
               }
           }
       }
   }
   return {first_local_index, first_local_index+n_local_training_samples};
 }

◆ generate_training_parameters_random()

std::pair< std::size_t, std::size_t > libMesh::RBConstructionBase< System >::generate_training_parameters_random	(	const Parallel::Communicator &	communicator,
		const std::map< std::string, bool > &	log_param_scale,
		std::map< std::string, std::vector< RBParameter >> &	local_training_parameters_in,
		const unsigned int	n_global_training_samples_in,
		const RBParameters &	min_parameters,
		const RBParameters &	max_parameters,
		const int	training_parameters_random_seed = `-1`,
		const bool	serial_training_set = `false`
	)

staticinherited

Static helper function for generating a randomized set of parameters.

The parameter n_global_training_samples_in is the total number of parameters to generate, and they will be split across all the processors (unless serial_training_set=true) in the local_training_parameters_in map.

Returns: a pair of {first_local_index,last_local_index}

Definition at line 472 of file rb_construction_base.C.

 {
   const unsigned int num_params = min_parameters.n_parameters();
   libmesh_error_msg_if(num_params!=max_parameters.n_parameters(),
     "Number of parameters must be identical for min/max.");
 
   // Clear training_parameters_in
   local_training_parameters_in.clear();
 
   if (num_params == 0)
     return {0,0};
 
   if (training_parameters_random_seed < 0)
     {
       if (!serial_training_set)
         {
           // seed the random number generator with the system time
           // and the processor ID so that the seed is different
           // on different processors
           std::srand( static_cast<unsigned>( std::time(0)*(1+communicator.rank()) ));
         }
       else
         {
           // seed the random number generator with the system time
           // only so that the seed is the same on all processors
           //
           // Note that we broadcast the time on processor 0 to make
           // sure all processors agree.
           unsigned int current_time = static_cast<unsigned>( std::time(0) );
           communicator.broadcast(current_time, 0);
           std::srand(current_time);
         }
     }
   else
     {
       if (!serial_training_set)
         {
           // seed the random number generator with the provided value
           // and the processor ID so that the seed is different
           // on different processors
           std::srand( static_cast<unsigned>( training_parameters_random_seed*(1+communicator.rank()) ));
         }
       else
         {
           // seed the random number generator with the provided value
           // so that the seed is the same on all processors
           std::srand( static_cast<unsigned>( training_parameters_random_seed ));
         }
     }
 
   // TODO - we don't support vector-data here yet. This would only apply in the case where
   //        min or max are vector-valued, and all the generated points need to stay within those ranges.
   //        But typically we expect that if we're calling this function, we only have 1 min and 1 max,
   //        so the generated values are single-valued as well. The .get_value() calls will throw an error
   //        if this is not the case.
 
   // initialize training_parameters_in
   const auto & [n_local_training_samples, first_local_index] =
       calculate_n_local_samples_and_index(communicator, n_global_training_samples_in,
                                           serial_training_set);
   for (const auto & pr : min_parameters)
     local_training_parameters_in[pr.first] = std::vector<RBParameter>(n_local_training_samples);
 
   // finally, set the values
   for (auto & [param_name, sample_vector] : local_training_parameters_in)
     {
       for (auto i : make_range(n_local_training_samples))
         {
           Real random_number = static_cast<Real>(std::rand()) / RAND_MAX; // in range [0,1]
 
           // Generate log10 scaled training parameters
           if (libmesh_map_find(log_param_scale, param_name))
             {
               Real log_min   = std::log10(min_parameters.get_value(param_name));
               Real log_range = std::log10(max_parameters.get_value(param_name) / min_parameters.get_value(param_name));
 
               sample_vector[i] = {std::pow(Real(10.), log_min + random_number*log_range )};
             }
           // Generate linearly scaled training parameters
           else
             {
               sample_vector[i] = {
                   random_number * (max_parameters.get_value(param_name) -
                                    min_parameters.get_value(param_name)) +
                   min_parameters.get_value(param_name)};
             }
         }
     }
   return {first_local_index, first_local_index+n_local_training_samples};
 }

◆ get_abs_training_tolerance()

Real libMesh::RBEIMConstruction::get_abs_training_tolerance ( )

inherited

Definition at line 1205 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_abs_training_tolerance.

Referenced by libMesh::RBEIMConstruction::print_info(), and libMesh::RBEIMConstruction::train_eim_approximation_with_greedy().

 {
   return _abs_training_tolerance;
 }

◆ 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

Definition at line 1294 of file system.C.

References libMesh::System::get_vector().

Referenced by libMesh::ImplicitSystem::adjoint_solve(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), and libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

 {
   std::ostringstream adjoint_rhs_name;
   adjoint_rhs_name << "adjoint_rhs" << i;
 
   return this->get_vector(adjoint_rhs_name.str());
 }

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

Definition at line 1304 of file system.C.

References libMesh::System::get_vector().

 {
   std::ostringstream adjoint_rhs_name;
   adjoint_rhs_name << "adjoint_rhs" << i;
 
   return this->get_vector(adjoint_rhs_name.str());
 }

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

Definition at line 1232 of file system.C.

References libMesh::System::get_vector().

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::ImplicitSystem::adjoint_solve(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::AdjointResidualErrorEstimator::estimate_error(), HeatSystem::init_context(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), main(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), libMesh::FileSolutionHistory::retrieve(), and libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

 {
   std::ostringstream adjoint_name;
   adjoint_name << "adjoint_solution" << i;
 
   return this->get_vector(adjoint_name.str());
 }

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

Definition at line 1242 of file system.C.

References libMesh::System::get_vector().

 {
   std::ostringstream adjoint_name;
   adjoint_name << "adjoint_solution" << i;
 
   return this->get_vector(adjoint_name.str());
 }

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

Definition at line 1403 of file system.C.

References libMesh::DofMap::get_all_variable_numbers(), and libMesh::System::get_dof_map().

Referenced by MeshFunctionTest::read_variable_info_from_output_data(), MeshfunctionDFEM::test_mesh_function_dfem(), MeshfunctionDFEM::test_mesh_function_dfem_grad(), and SystemsTest::testProjectCubeWithMeshFunction().

 {
   this->get_dof_map().get_all_variable_numbers(all_variable_numbers);
 }

◆ get_closest_value()

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.

Definition at line 432 of file rb_parametrized.C.

References distance(), libMesh::Real, and value.

Referenced by libMesh::RBParametrized::is_value_in_list().

 {
   libmesh_error_msg_if(list_of_values.empty(), "Error: list_of_values is empty.");
 
   Real min_distance = std::numeric_limits<Real>::max();
   Real closest_val = 0.;
   for (const auto & current_value : list_of_values)
     {
       Real distance = std::abs(value - current_value);
       if (distance < min_distance)
         {
           min_distance = distance;
           closest_val = current_value;
         }
     }
 
   return closest_val;
 }

◆ get_constraint_object()

System::Constraint & libMesh::System::get_constraint_object ( )

inherited

Return the user object for imposing constraints.

Definition at line 2024 of file system.C.

References libMesh::System::_constrain_system_object.

 {
   libmesh_assert_msg(_constrain_system_object,"No constraint object available.");
   return *_constrain_system_object;
 }

◆ get_deterministic_training_parameter_name()

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

inherited

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

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

Definition at line 359 of file rb_parametrized.C.

References libMesh::RBParametrized::_discrete_parameter_values, and libMesh::RBParametrized::parameters_initialized.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), libMesh::RBParametrized::check_if_valid_params(), libMesh::RBParametrized::get_n_discrete_params(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBParametrized::print_discrete_parameter_values(), and libMesh::RBParametrized::write_discrete_parameter_values_to_file().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_discrete_parameter_values");
 
   return _discrete_parameter_values;
 }

◆ get_dof_map() [1/2]

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

inlineinherited

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

Definition at line 2417 of file system.h.

References libMesh::System::_dof_map.

 {
   return *_dof_map;
 }

◆ get_dof_map() [2/2]

DofMap & libMesh::System::get_dof_map ( )

inlineinherited

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

Definition at line 2425 of file system.h.

References libMesh::System::_dof_map.

 {
   return *_dof_map;
 }

◆ get_eim_assembly_objects()

std::vector< std::unique_ptr< ElemAssembly > > & libMesh::RBEIMConstruction::get_eim_assembly_objects ( )

inherited

Returns: The vector of assembly objects that point to this RBEIMConstruction.

Definition at line 1160 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rb_eim_assembly_objects.

Referenced by main().

 {
   return _rb_eim_assembly_objects;
 }

◆ get_equation_systems() [1/2]

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

inlineinherited

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

Definition at line 767 of file system.h.

References libMesh::System::_equation_systems.

767 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:2231

◆ get_equation_systems() [2/2]

EquationSystems& libMesh::System::get_equation_systems ( )

inlineinherited

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

Definition at line 772 of file system.h.

References libMesh::System::_equation_systems.

772 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:2231

◆ get_first_local_training_index()

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

inherited

Get the first local index of the training parameters.

Definition at line 191 of file rb_construction_base.C.

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: training parameters must first be initialized.");
 
   // First we check if there are no parameters here, and in that case we
   // return 0 for a serial training set and comm().rank() for a parallel
   // training set. This is consistent with get_n_training_samples(), and
   // avoids accessing training_parameters.begin() when training_parameters
   // is empty.
   if (_training_parameters.empty())
     {
       if (serial_training_set)
         return 0;
       else
         return this->comm().rank();
     }
 
   return _first_local_index;
 }

◆ get_global_max_error_pair()

void libMesh::RBConstructionBase< System >::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.

Definition at line 134 of file rb_construction_base.C.

 {
   // Set error_pair.second to the maximum global value and also
   // find which processor contains the maximum value
   unsigned int proc_ID_index;
   communicator.maxloc(error_pair.second, proc_ID_index);
 
   // Then broadcast error_pair.first from proc_ID_index
   communicator.broadcast(error_pair.first, proc_ID_index);
 }

◆ get_info() [1/3]

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

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

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

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

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
   std::ostringstream oss;
 
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
 
   for (const auto & [name, cd] : _counts)
     oss << "| " << name << " reference count information:\n"
         << "|  Creations:    " << cd.first    << '\n'
         << "|  Destructions: " << cd.second << '\n';
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ get_info() [2/3]

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

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

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

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

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
   std::ostringstream oss;
 
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
 
   for (const auto & [name, cd] : _counts)
     oss << "| " << name << " reference count information:\n"
         << "|  Creations:    " << cd.first    << '\n'
         << "|  Destructions: " << cd.second << '\n';
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ get_info() [3/3]

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

inherited

Returns: A string containing information about the system.

Definition at line 1827 of file system.C.

Referenced by SystemsTest::testUninitializedInfo().

 {
   std::ostringstream oss;
 
 
   const std::string & sys_name = this->name();
 
   oss << "   System #"  << this->number() << ", \"" << sys_name << "\"\n"
       << "    Type \""  << this->system_type() << "\"\n"
       << "    Variables=";
 
   for (auto vg : make_range(this->n_variable_groups()))
     {
       const VariableGroup & vg_description (this->variable_group(vg));
 
       if (vg_description.n_variables() > 1) oss << "{ ";
       for (auto vn : make_range(vg_description.n_variables()))
         oss << "\"" << vg_description.name(vn) << "\" ";
       if (vg_description.n_variables() > 1) oss << "} ";
     }
 
   oss << '\n';
 
   oss << "    Finite Element Types=";
 #ifndef LIBMESH_ENABLE_INFINITE_ELEMENTS
   for (auto vg : make_range(this->n_variable_groups()))
     oss << "\""
         << Utility::enum_to_string<FEFamily>(this->get_dof_map().variable_group(vg).type().family)
         << "\" ";
 #else
   for (auto vg : make_range(this->n_variable_groups()))
     {
       oss << "\""
           << Utility::enum_to_string<FEFamily>(this->get_dof_map().variable_group(vg).type().family)
           << "\", \""
           << Utility::enum_to_string<FEFamily>(this->get_dof_map().variable_group(vg).type().radial_family)
           << "\" ";
     }
 
   oss << '\n' << "    Infinite Element Mapping=";
   for (auto vg : make_range(this->n_variable_groups()))
     oss << "\""
         << Utility::enum_to_string<InfMapType>(this->get_dof_map().variable_group(vg).type().inf_map)
         << "\" ";
 #endif
 
   oss << '\n';
 
   oss << "    Approximation Orders=";
   for (auto vg : make_range(this->n_variable_groups()))
     {
 #ifndef LIBMESH_ENABLE_INFINITE_ELEMENTS
       oss << "\""
           << Utility::enum_to_string<Order>(this->get_dof_map().variable_group(vg).type().order)
           << "\" ";
 #else
       oss << "\""
           << Utility::enum_to_string<Order>(this->get_dof_map().variable_group(vg).type().order)
           << "\", \""
           << Utility::enum_to_string<Order>(this->get_dof_map().variable_group(vg).type().radial_order)
           << "\" ";
 #endif
     }
 
   oss << '\n';
 
   if (this->is_initialized())
     {
       oss << "    n_dofs()="             << this->n_dofs()             << '\n';
       dof_id_type local_dofs = this->n_local_dofs();
       oss << "    n_local_dofs()="       << local_dofs                 << '\n';
       this->comm().max(local_dofs);
       oss << "    max(n_local_dofs())="  << local_dofs                 << '\n';
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
       if (this->n_constrained_dofs())
         {
           oss << "    n_constrained_dofs()=" << this->n_constrained_dofs() << '\n';
           oss << "    n_local_constrained_dofs()=" << this->n_local_constrained_dofs() << '\n';
           dof_id_type local_unconstrained_dofs = this->n_local_dofs() - this->n_local_constrained_dofs();
           this->comm().max(local_unconstrained_dofs);
           oss << "    max(local unconstrained dofs)=" << local_unconstrained_dofs << '\n';
         }
 #endif
       if (this->has_static_condensation())
         oss << "    n uncondensed dofs="
             << this->get_dof_map().get_static_condensation().n_dofs() << '\n';
     }
   else
     oss << "    (still uninitialized)\n";
 
   oss << "    " << "n_vectors()="  << this->n_vectors()  << '\n';
   oss << "    " << "n_matrices()="  << this->n_matrices()  << '\n';
   //   oss << "    " << "n_additional_matrices()=" << this->n_additional_matrices() << '\n';
 
   oss << this->get_dof_map().get_info();
 
   return oss.str();
 }

◆ get_last_local_training_index()

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

inherited

Get the last local index of the training parameters.

Definition at line 213 of file rb_construction_base.C.

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: training parameters must first be initialized.");
 
   if (_training_parameters.empty())
     return 0;
 
   return _first_local_index + _n_local_training_samples;
 }

◆ get_local_n_training_samples()

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

inherited

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

Definition at line 175 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::compute_max_eim_error().

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: training parameters must first be initialized.");
 
   // First we check if there are no parameters here, and in that case we
   // return 1 for both serial and parallel training sets. This is consistent
   // with get_n_training_samples(), and avoids accessing
   // training_parameters.begin() when training_parameters is empty.
   if (_training_parameters.empty())
     return 1;
 
   return _n_local_training_samples;
 }

◆ get_local_quad_point_JxW()

const std::unordered_map< dof_id_type, std::vector< Real > > & libMesh::RBEIMConstruction::get_local_quad_point_JxW ( )

inherited

Get the interior and side quadrature weights.

Definition at line 1341 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_quad_point_JxW.

 {
   return _local_quad_point_JxW;
 }

◆ get_local_side_quad_point_JxW()

const std::map< std::pair< dof_id_type, unsigned int >, std::vector< Real > > & libMesh::RBEIMConstruction::get_local_side_quad_point_JxW ( )

inherited

Definition at line 1346 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_side_quad_point_JxW.

 {
   return _local_side_quad_point_JxW;
 }

◆ get_matrix() [1/2]

const SparseMatrix< Number > & libMesh::System::get_matrix ( std::string_view mat_name ) const

inherited

Returns: A const reference to this system's matrix named mat_name.

Definition at line 1111 of file system.C.

References libMesh::System::_matrices.

Referenced by add_M_C_K_helmholtz(), assemble(), assemble_helmholtz(), assemble_poisson(), libMesh::NewmarkSystem::compute_matrix(), libMesh::ImplicitSystem::get_system_matrix(), main(), libMesh::EigenTimeSolver::solve(), and libMesh::NewmarkSystem::update_rhs().

 {
   return *libmesh_map_find(_matrices, mat_name);
 }

◆ get_matrix() [2/2]

SparseMatrix< Number > & libMesh::System::get_matrix ( std::string_view mat_name )

inherited

Returns: A writable reference to this system's matrix named mat_name.

Definition at line 1118 of file system.C.

References libMesh::System::_matrices.

 {
   return *libmesh_map_find(_matrices, mat_name);
 }

◆ get_max_abs_value_in_training_set()

Real libMesh::RBEIMConstruction::get_max_abs_value_in_training_set ( ) const

inherited

Get the maximum value (across all processors) from the parametrized functions in the training set.

Definition at line 1232 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_max_abs_value_in_training_set.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation_with_greedy().

 {
   return _max_abs_value_in_training_set;
 }

◆ get_mesh() [1/2]

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

inlineinherited

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

Definition at line 2401 of file system.h.

References libMesh::System::_mesh.

 {
   return _mesh;
 }

◆ get_mesh() [2/2]

MeshBase & libMesh::System::get_mesh ( )

inlineinherited

Returns: A reference to this systems's _mesh.

Definition at line 2409 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.

Definition at line 112 of file rb_parametrized.C.

References libMesh::RBParametrized::get_n_discrete_params(), libMesh::RBParametrized::get_n_params(), libMesh::libmesh_assert(), and libMesh::RBParametrized::parameters_initialized.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), and libMesh::RBParametrized::write_parameter_ranges_to_file().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_n_continuous_params");
 
   libmesh_assert(get_n_params() >= get_n_discrete_params());
 
   return static_cast<unsigned int>(get_n_params() - get_n_discrete_params());
 }

◆ get_n_discrete_params()

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

inherited

Get the number of discrete parameters.

Definition at line 121 of file rb_parametrized.C.

References libMesh::RBParametrized::get_discrete_parameter_values(), and libMesh::RBParametrized::parameters_initialized.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), libMesh::RBParametrized::get_n_continuous_params(), and libMesh::RBParametrized::write_discrete_parameter_values_to_file().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_n_discrete_params");
 
   return cast_int<unsigned int>
     (get_discrete_parameter_values().size());
 }

◆ get_n_parametrized_functions_for_training()

unsigned int libMesh::RBEIMConstruction::get_n_parametrized_functions_for_training ( ) const

inherited

Get the number of parametrized functions used for training.

Definition at line 1351 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_node_parametrized_functions_for_training, libMesh::RBEIMConstruction::_local_parametrized_functions_for_training, libMesh::RBEIMConstruction::_local_side_parametrized_functions_for_training, and libMesh::RBEIMConstruction::get_rb_eim_evaluation().

 {
   if (get_rb_eim_evaluation().get_parametrized_function().on_mesh_sides())
     return _local_side_parametrized_functions_for_training.size();
   else if (get_rb_eim_evaluation().get_parametrized_function().on_mesh_nodes())
     return _local_node_parametrized_functions_for_training.size();
   else
     return _local_parametrized_functions_for_training.size();
 }

◆ get_n_params()

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

inherited

Get the number of parameters.

Definition at line 103 of file rb_parametrized.C.

References libMesh::RBParameters::n_parameters(), libMesh::RBParametrized::parameters_initialized, libMesh::RBParametrized::parameters_max, and libMesh::RBParametrized::parameters_min.

Referenced by libMesh::RBParametrized::check_if_valid_params(), libMesh::RBEIMConstruction::compute_max_eim_error(), libMesh::RBConstruction::compute_max_error_bound(), libMesh::RBParametrized::get_n_continuous_params(), libMesh::RBSCMConstruction::print_info(), libMesh::RBEIMConstruction::print_info(), libMesh::RBConstruction::print_info(), libMesh::RBEIMEvaluation::set_eim_error_indicator_active(), and libMesh::RBConstruction::train_reduced_basis_with_POD().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_n_params");
 
   libmesh_assert_equal_to ( parameters_min.n_parameters(), parameters_max.n_parameters() );
 
   return parameters_min.n_parameters();
 }

◆ get_n_training_samples()

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

inherited

Get the number of global training samples.

Definition at line 153 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::apply_normalization_to_solution_snapshots(), libMesh::RBEIMConstruction::compute_max_eim_error(), libMesh::RBEIMConstruction::initialize_parametrized_functions_in_training_set(), libMesh::RBEIMConstruction::print_info(), libMesh::RBEIMConstruction::store_eim_solutions_for_training_set(), libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: training parameters must first be initialized.");
 
   // First we check if there are no parameters here, and in that case we
   // return 1 since a single training sample is sufficient to generate an
   // RB approximation if there are no parameters. Note that in parallel,
   // and when we don't have a serial training set, set return comm().size()
   // so that each processor is assigned a single (empty) training sample.
   if (_training_parameters.empty())
     {
       if (serial_training_set)
         return 1;
       else
         return this->comm().size();
     }
 
   return _n_global_training_samples;
 }

◆ get_Nmax()

unsigned int libMesh::RBEIMConstruction::get_Nmax ( ) const

inherited

Get/set Nmax, the maximum number of RB functions we are willing to compute.

Definition at line 1210 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_Nmax.

Referenced by libMesh::RBEIMConstruction::print_info(), libMesh::RBEIMConstruction::reinit_eim_projection_matrix(), libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   return _Nmax;
 }

◆ get_node_parametrized_function_from_training_set()

const RBEIMEvaluation::NodeDataMap & libMesh::RBEIMConstruction::get_node_parametrized_function_from_training_set ( unsigned int training_index ) const

inherited

Definition at line 1334 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_node_parametrized_functions_for_training.

 {
   libmesh_error_msg_if(training_index >= _local_node_parametrized_functions_for_training.size(),
                        "Invalid index: " << training_index);
   return _local_node_parametrized_functions_for_training[training_index];
 }

◆ get_parameter_max()

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

inherited

Get maximum allowable value of parameter param_name.

Definition at line 171 of file rb_parametrized.C.

References libMesh::RBParameters::get_value(), libMesh::RBParametrized::parameters_initialized, and libMesh::RBParametrized::parameters_max.

Referenced by libMesh::RBParametrized::check_if_valid_params(), libMesh::RBSCMConstruction::print_info(), libMesh::RBEIMConstruction::print_info(), and libMesh::RBConstruction::print_info().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_parameter_max");
 
   return parameters_max.get_value(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.

Definition at line 164 of file rb_parametrized.C.

References libMesh::RBParameters::get_value(), libMesh::RBParametrized::parameters_initialized, and libMesh::RBParametrized::parameters_min.

Referenced by libMesh::RBParametrized::check_if_valid_params(), libMesh::RBSCMConstruction::print_info(), libMesh::RBEIMConstruction::print_info(), and libMesh::RBConstruction::print_info().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_parameter_min");
 
   return parameters_min.get_value(param_name);
 }

◆ get_parameters()

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

inherited

Get the current parameters.

Definition at line 143 of file rb_parametrized.C.

References libMesh::RBParametrized::parameters, and libMesh::RBParametrized::parameters_initialized.

Referenced by libMesh::TransientRBConstruction::add_scaled_mass_matrix(), libMesh::TransientRBEvaluation::cache_online_residual_terms(), libMesh::RBEvaluation::compute_residual_dual_norm(), libMesh::RBSCMConstruction::compute_SCM_bounds_on_training_set(), libMesh::RBSCMConstruction::enrich_C_J(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_interiors(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_nodes(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_sides(), libMesh::RBEvaluation::eval_output_dual_norm(), libMesh::RBSCMConstruction::evaluate_stability_constant(), libMesh::RBConstruction::get_RB_error_bound(), libMesh::RBSCMEvaluation::get_SCM_LB(), libMesh::RBSCMEvaluation::get_SCM_UB(), SimpleRBEvaluation::get_stability_lower_bound(), libMesh::RBConstruction::greedy_termination_test(), libMesh::RBEIMConstruction::initialize_parametrized_functions_in_training_set(), libMesh::RBSCMEvaluation::legacy_read_offline_data_from_files(), libMesh::TransientRBConstruction::mass_matrix_scaled_matvec(), libMesh::RBConstruction::preevaluate_thetas(), libMesh::RBSCMConstruction::print_info(), libMesh::RBEIMConstruction::print_info(), libMesh::RBConstruction::print_info(), libMesh::RBParametrized::print_parameters(), libMesh::RBSCMConstruction::process_parameters_file(), libMesh::TransientRBEvaluation::rb_solve(), libMesh::RBEvaluation::rb_solve(), libMesh::RBSCMEvaluation::save_current_parameters(), libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), libMesh::RBEIMConstruction::train_eim_approximation_with_POD(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::RBConstruction::truth_assembly(), libMesh::TransientRBConstruction::truth_solve(), libMesh::RBConstruction::truth_solve(), libMesh::TransientRBEvaluation::uncached_compute_residual_dual_norm(), and libMesh::RBConstruction::update_greedy_param_list().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_parameters");
 
   return parameters;
 }

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

Definition at line 157 of file rb_parametrized.C.

References libMesh::RBParametrized::parameters_initialized, and libMesh::RBParametrized::parameters_max.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBSCMConstruction::process_parameters_file(), libMesh::RBEIMConstruction::set_rb_construction_parameters(), libMesh::RBConstruction::set_rb_construction_parameters(), and libMesh::RBParametrized::write_parameter_ranges_to_file().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_parameters_max");
 
   return parameters_max;
 }

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

Definition at line 150 of file rb_parametrized.C.

References libMesh::RBParametrized::parameters_initialized, and libMesh::RBParametrized::parameters_min.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBSCMConstruction::process_parameters_file(), libMesh::RBEIMConstruction::set_rb_construction_parameters(), libMesh::RBConstruction::set_rb_construction_parameters(), and libMesh::RBParametrized::write_parameter_ranges_to_file().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::get_parameters_min");
 
   return parameters_min;
 }

◆ get_parametrized_function_from_training_set()

const RBEIMEvaluation::QpDataMap & libMesh::RBEIMConstruction::get_parametrized_function_from_training_set ( unsigned int training_index ) const

inherited

Get a const reference to the specified parametrized function from the training set.

Definition at line 1320 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_parametrized_functions_for_training.

 {
   libmesh_error_msg_if(training_index >= _local_parametrized_functions_for_training.size(),
                        "Invalid index: " << training_index);
   return _local_parametrized_functions_for_training[training_index];
 }

◆ get_params_from_training_set()

RBParameters libMesh::RBConstructionBase< System >::get_params_from_training_set ( unsigned int global_index )

protectedinherited

Return the RBParameters in index global_index of the global training set.

Why do we use an index here? RBParameters supports loading the full sample set. This seems probably unnecessary now to load individually. Maybe it's a memory issue?

Definition at line 231 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::compute_max_eim_error().

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: training parameters must first be initialized.");
 
   // If the _training_parameters are empty, return an empty RBParameters.
   // Otherwise, create a new RBParameters object from the single sample requested.
   RBParameters params;
   if (!_training_parameters.empty())
     {
       libmesh_error_msg_if((global_index < this->get_first_local_training_index()) ||
                            (global_index >= this->get_last_local_training_index()),
                            "Error: index "
                            << global_index
                            << " must be within range: "
                            << this->get_first_local_training_index()
                            << " - "
                            << this->get_last_local_training_index());
 
       const numeric_index_type local_index = global_index - get_first_local_training_index();
       for (const auto & [param_name, sample_vector] : _training_parameters)
         params.set_value(param_name, sample_vector[local_index]);
 
       // Copy all extra values into the new RBParameters.
       // We assume that the samples may be indexed differently for extra parameters,
       // so we don't just copy the local_index value.
       const auto & mine = get_parameters();
       for (const auto & [key, extra_sample_vector] :
            as_range(mine.extra_begin(), mine.extra_end()))
         {
           for (const auto idx : index_range(extra_sample_vector))
             params.set_extra_value(key, idx, extra_sample_vector[idx]);
         }
     }
 
   return params;
 }

◆ get_project_with_constraints()

bool libMesh::System::get_project_with_constraints ( )

inlineinherited

Setter and getter functions for project_with_constraints boolean.

Definition at line 1837 of file system.h.

References libMesh::System::project_with_constraints.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error().

   {
     return project_with_constraints;
   }

◆ get_qoi_error_estimate_value()

Number libMesh::System::get_qoi_error_estimate_value ( unsigned int qoi_index ) const

inherited

Definition at line 2211 of file system.C.

References libMesh::System::_qoi_error_estimates, and libMesh::libmesh_assert().

Referenced by libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), and main().

 {
   libmesh_assert(qoi_index < _qoi_error_estimates.size());
   return _qoi_error_estimates[qoi_index];
 }

◆ get_qoi_value()

Number libMesh::System::get_qoi_value ( unsigned int qoi_index ) const

inherited

Definition at line 2184 of file system.C.

References libMesh::System::_qoi, and libMesh::libmesh_assert().

Referenced by libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), main(), libMesh::ImplicitSystem::qoi_parameter_hessian(), and libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product().

 {
   libmesh_assert(qoi_index < _qoi.size());
   return _qoi[qoi_index];
 }

◆ get_qoi_values()

std::vector< Number > libMesh::System::get_qoi_values ( ) const

inherited

Returns a copy of qoi, not a reference.

Definition at line 2191 of file system.C.

References libMesh::System::_qoi.

Referenced by libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), libMesh::FEMSystem::assemble_qoi(), libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), libMesh::ImplicitSystem::qoi_parameter_hessian(), and libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product().

 {
   return this->_qoi;
 }

◆ get_rb_eim_evaluation() [1/2]

RBEIMEvaluation & libMesh::RBEIMConstruction::get_rb_eim_evaluation ( )

inherited

Get a reference to the RBEvaluation object.

Definition at line 157 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rb_eim_eval.

 {
   libmesh_error_msg_if(!_rb_eim_eval, "Error: RBEIMEvaluation object hasn't been initialized yet");
   return *_rb_eim_eval;
 }

◆ get_rb_eim_evaluation() [2/2]

const RBEIMEvaluation & libMesh::RBEIMConstruction::get_rb_eim_evaluation ( ) const

inherited

Get a const reference to the RBEvaluation object.

Definition at line 163 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rb_eim_eval.

 {
   libmesh_error_msg_if(!_rb_eim_eval, "Error: RBEIMEvaluation object hasn't been initialized yet");
   return *_rb_eim_eval;
 }

◆ get_rel_training_tolerance()

Real libMesh::RBEIMConstruction::get_rel_training_tolerance ( )

inherited

Definition at line 1195 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rel_training_tolerance.

Referenced by libMesh::RBEIMConstruction::print_info(), libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   return _rel_training_tolerance;
 }

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

Definition at line 1324 of file system.C.

References libMesh::System::get_vector().

Referenced by libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), and libMesh::ImplicitSystem::sensitivity_solve().

 {
   std::ostringstream sensitivity_rhs_name;
   sensitivity_rhs_name << "sensitivity_rhs" << i;
 
   return this->get_vector(sensitivity_rhs_name.str());
 }

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

Definition at line 1334 of file system.C.

References libMesh::System::get_vector().

 {
   std::ostringstream sensitivity_rhs_name;
   sensitivity_rhs_name << "sensitivity_rhs" << i;
 
   return this->get_vector(sensitivity_rhs_name.str());
 }

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

Definition at line 1179 of file system.C.

References libMesh::System::get_vector().

Referenced by libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), libMesh::ImplicitSystem::qoi_parameter_hessian(), and libMesh::ImplicitSystem::sensitivity_solve().

 {
   std::ostringstream sensitivity_name;
   sensitivity_name << "sensitivity_solution" << i;
 
   return this->get_vector(sensitivity_name.str());
 }

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

Definition at line 1189 of file system.C.

References libMesh::System::get_vector().

 {
   std::ostringstream sensitivity_name;
   sensitivity_name << "sensitivity_solution" << i;
 
   return this->get_vector(sensitivity_name.str());
 }

◆ get_side_parametrized_function_from_training_set()

const RBEIMEvaluation::SideQpDataMap & libMesh::RBEIMConstruction::get_side_parametrized_function_from_training_set ( unsigned int training_index ) const

inherited

Definition at line 1327 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_local_side_parametrized_functions_for_training.

 {
   libmesh_error_msg_if(training_index >= _local_side_parametrized_functions_for_training.size(),
                        "Invalid index: " << training_index);
   return _local_side_parametrized_functions_for_training[training_index];
 }

◆ get_vector() [1/4]

const NumericVector< Number > & libMesh::System::get_vector ( std::string_view 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.

Definition at line 931 of file system.C.

References libMesh::System::_vectors.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), add_M_C_K_helmholtz(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::NewmarkSolver::advance_timestep(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), apply_initial(), assemble(), libMesh::System::compare(), libMesh::NewmarkSolver::compute_initial_accel(), libMesh::UnsteadySolver::du(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::System::get_adjoint_rhs(), libMesh::System::get_adjoint_solution(), libMesh::System::get_sensitivity_rhs(), libMesh::System::get_sensitivity_solution(), libMesh::System::get_weighted_sensitivity_adjoint_solution(), libMesh::System::get_weighted_sensitivity_solution(), libMesh::NewmarkSystem::initial_conditions(), AssembleOptimization::lower_and_upper_bounds(), main(), libMesh::NewmarkSolver::project_initial_accel(), libMesh::SecondOrderUnsteadySolver::project_initial_rate(), libMesh::InterMeshProjection::project_system_vectors(), libMesh::SecondOrderUnsteadySolver::reinit(), libMesh::UnsteadySolver::reinit(), libMesh::FileSolutionHistory::retrieve(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::MemoryHistoryData::retrieve_vectors(), libMesh::TwostepTimeSolver::solve(), libMesh::FrequencySystem::solve(), libMesh::UnsteadySolver::update(), libMesh::NewmarkSystem::update_rhs(), and libMesh::NewmarkSystem::update_u_v_a().

 {
   return *(libmesh_map_find(_vectors, vec_name));
 }

◆ get_vector() [2/4]

NumericVector< Number > & libMesh::System::get_vector ( std::string_view 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.

Definition at line 938 of file system.C.

References libMesh::System::_vectors.

 {
   return *(libmesh_map_find(_vectors, vec_name));
 }

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

Definition at line 945 of file system.C.

References libMesh::System::_vectors, and libMesh::System::vectors_begin().

 {
   // If we don't have that many vectors, throw an error
   libmesh_assert_less(vec_num, _vectors.size());
 
   // Otherwise return a reference to the vec_num'th vector
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return *(it->second);
 }

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

Definition at line 958 of file system.C.

References libMesh::System::_vectors, and libMesh::System::vectors_begin().

 {
   // If we don't have that many vectors, throw an error
   libmesh_assert_less(vec_num, _vectors.size());
 
   // Otherwise return a reference to the vec_num'th vector
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return *(it->second);
 }

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

Definition at line 1264 of file system.C.

References libMesh::System::get_vector().

Referenced by libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), and libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

 {
   std::ostringstream adjoint_name;
   adjoint_name << "weighted_sensitivity_adjoint_solution" << i;
 
   return this->get_vector(adjoint_name.str());
 }

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

Definition at line 1274 of file system.C.

References libMesh::System::get_vector().

 {
   std::ostringstream adjoint_name;
   adjoint_name << "weighted_sensitivity_adjoint_solution" << i;
 
   return this->get_vector(adjoint_name.str());
 }

◆ 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

Definition at line 1206 of file system.C.

References libMesh::System::get_vector().

Referenced by libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), and libMesh::ImplicitSystem::weighted_sensitivity_solve().

 {
   return this->get_vector("weighted_sensitivity_solution");
 }

◆ 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

Definition at line 1213 of file system.C.

References libMesh::System::get_vector().

 {
   return this->get_vector("weighted_sensitivity_solution");
 }

◆ has_constraint_object()

bool libMesh::System::has_constraint_object ( ) const

inherited

Returns: true if there is a user-defined constraint object attached to this object, false otherwise. Calling System:: get_constraint_object() when there is no user-defined constraint object attached leads to either undefined behavior (dereferencing a nullptr) or an assert (in dbg mode) so you should call this function first unless you are sure there is a user-defined constraint object attached.

Definition at line 2019 of file system.C.

References libMesh::System::_constrain_system_object.

 {
   return _constrain_system_object != nullptr;
 }

◆ has_static_condensation()

bool libMesh::System::has_static_condensation ( ) const

inherited

Returns: Whether this system will be statically condensed

Definition at line 2669 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::has_static_condensation().

Referenced by libMesh::System::add_matrix(), assemble_poisson(), libMesh::LinearImplicitSystem::clear(), libMesh::ImplicitSystem::clear(), libMesh::NonlinearImplicitSystem::clear(), libMesh::System::get_info(), libMesh::ImplicitSystem::ImplicitSystem(), libMesh::LinearImplicitSystem::LinearImplicitSystem(), and libMesh::NonlinearImplicitSystem::NonlinearImplicitSystem().

 {
   return this->get_dof_map().has_static_condensation();
 }

◆ has_variable()

bool libMesh::System::has_variable ( std::string_view var ) const

inherited

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

Definition at line 1393 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::has_variable().

Referenced by libMesh::GMVIO::copy_nodal_solution(), and main().

 {
   return this->get_dof_map().has_variable(var);
 }

◆ have_matrix()

bool libMesh::System::have_matrix ( std::string_view mat_name ) const

inlineinherited

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

Definition at line 1933 of file system.h.

References libMesh::System::_matrices.

Referenced by libMesh::EigenTimeSolver::init().

1933 { return _matrices.count(mat_name); }

libMesh::System::_matrices

std::map< std::string, std::unique_ptr< SparseMatrix< Number > >, std::less<> > _matrices

Some systems need an arbitrary number of matrices.

Definition: system.h:2277

◆ have_vector()

bool libMesh::System::have_vector ( std::string_view vec_name ) const

inlineinherited

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

Definition at line 2491 of file system.h.

References libMesh::System::_vectors.

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

◆ hide_output()

bool& libMesh::System::hide_output ( )

inlineinherited

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 1852 of file system.h.

References libMesh::System::_hide_output.

Referenced by libMesh::StaticCondensationDofMap::reinit(), libMesh::PetscPreconditioner< T >::set_hypre_ads_data(), and libMesh::PetscPreconditioner< T >::set_hypre_ams_data().

1852 { 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:2338

◆ 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 2684 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::identify_variable_groups().

 {
   return this->get_dof_map().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 2689 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::identify_variable_groups().

 {
   this->get_dof_map().identify_variable_groups(ivg);
 }

◆ increment_constructor_count() [1/2]

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.first++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_constructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_constructor_count() [2/2]

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.first++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_constructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_destructor_count() [1/2]

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.second++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_destructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_destructor_count() [2/2]

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.second++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_destructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ init()

void libMesh::System::init ( )

inherited

Initializes degrees of freedom on the current mesh.

Sets the

Definition at line 196 of file system.C.

References libMesh::System::is_initialized(), libMesh::libmesh_assert(), and libMesh::System::reinit_mesh().

Referenced by libMesh::StaticCondensationDofMap::reinit().

 {
   // Calling init() twice on the same system currently works evil
   // magic, whether done directly or via EquationSystems::read()
   libmesh_assert(!this->is_initialized());
 
   this->reinit_mesh();
 }

◆ init_context()

void libMesh::RBEIMConstruction::init_context ( FEMContext & c )

virtualinherited

Pre-request FE data needed for calculations.

Definition at line 1165 of file rb_eim_construction.C.

References dim, libMesh::FEMContext::get_element_fe(), libMesh::System::get_mesh(), libMesh::FEMContext::get_side_fe(), libMesh::DiffContext::get_system(), libMesh::make_range(), mesh, and libMesh::System::n_vars().

Referenced by libMesh::RBEIMConstruction::enrich_eim_approximation_on_sides(), and libMesh::RBEIMConstruction::initialize_qp_data().

 {
   // Pre-request FE data for all element dimensions present in the
   // mesh.  Note: we currently pre-request FE data for all variables
   // in the current system but in some cases that may be overkill, for
   // example if only variable 0 is used.
   const System & sys = c.get_system();
   const MeshBase & mesh = sys.get_mesh();
 
   for (unsigned int dim=1; dim<=3; ++dim)
     if (mesh.elem_dimensions().count(dim))
       for (auto var : make_range(sys.n_vars()))
       {
         auto fe = c.get_element_fe(var, dim);
         fe->get_JxW();
         fe->get_xyz();
         fe->get_phi();
 
         auto side_fe = c.get_side_fe(var, dim);
         side_fe->get_JxW();
         side_fe->get_xyz();
         side_fe->get_phi();
       }
 }

◆ init_data() [1/2]

virtual void SimpleEIMConstruction::init_data ( )

inlinevirtual

Initialize data structures.

Reimplemented from libMesh::RBConstructionBase< System >.

Definition at line 58 of file eim_classes.h.

References libMesh::System::add_variable(), and libMesh::FIRST.

   {
     this->add_variable ("eim_var", libMesh::FIRST);
 
     RBEIMConstruction::init_data();
   }

◆ init_data() [2/2]

virtual void SimpleEIMConstruction::init_data ( )

inlinevirtual

Initialize data structures.

Reimplemented from libMesh::RBConstructionBase< System >.

Definition at line 64 of file eim_classes.h.

References libMesh::System::add_variable(), and libMesh::FIRST.

   {
     this->add_variable ("eim_var", libMesh::FIRST);
 
     RBEIMConstruction::init_data();
   }

◆ init_matrices()

void libMesh::System::init_matrices ( )

protectedvirtualinherited

Initializes the matrices associated with this system.

Reimplemented in libMesh::EigenSystem.

Definition at line 311 of file system.C.

References libMesh::System::_matrices, libMesh::System::_matrices_initialized, libMesh::System::_matrix_types, libMesh::System::_prefer_hash_table_matrix_assembly, libMesh::System::_require_sparsity_pattern, libMesh::DofMap::attach_matrix(), libMesh::DofMap::compute_sparsity(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::SparseMatrix< T >::initialized(), libMesh::DofMap::is_attached(), libMesh::libmesh_assert(), and libMesh::System::name().

Referenced by libMesh::System::init_data(), and libMesh::EigenSystem::init_matrices().

 {
   parallel_object_only();
 
   // No matrices to init
   if (_matrices.empty())
     {
       // any future matrices to be added will need their own
       // initialization
       _matrices_initialized = true;
 
       return;
     }
 
   // Check for quick return in case the first matrix
   // (and by extension all the matrices) has already
   // been initialized
   if (_matrices.begin()->second->initialized())
     {
       libmesh_assert(_matrices_initialized);
       return;
     }
 
   _matrices_initialized = true;
 
   // Tell the matrices about the dof map, and vice versa
   for (auto & pr : _matrices)
     {
       SparseMatrix<Number> & m = *(pr.second);
       libmesh_assert (!m.initialized());
 
       // We want to allow repeated init() on systems, but we don't
       // want to attach the same matrix to the DofMap twice
       if (!this->get_dof_map().is_attached(m))
         this->get_dof_map().attach_matrix(m);
 
       // If the user has already explicitly requested that this matrix use a hash table, then we
       // always honor that
       const bool use_hash =
           pr.second->use_hash_table() ||
           (this->_prefer_hash_table_matrix_assembly && pr.second->supports_hash_table());
       pr.second->use_hash_table(use_hash);
       // Make this call after we've determined whether the matrix is using a hash table
       if (pr.second->require_sparsity_pattern())
         this->_require_sparsity_pattern = true;
     }
 
   // Compute the sparsity pattern for the current
   // mesh and DOF distribution.  This also updates
   // additional matrices, \p DofMap now knows them
   if (this->_require_sparsity_pattern)
     this->get_dof_map().compute_sparsity(this->get_mesh());
 
   // Initialize matrices and set to zero
   for (auto & [name, mat] : _matrices)
     {
       mat->init(_matrix_types[name]);
       mat->zero();
     }
 }

◆ init_qois()

void libMesh::System::init_qois ( unsigned int n_qois )

inherited

Accessors for qoi and qoi_error_estimates vectors.

Definition at line 2169 of file system.C.

References libMesh::System::_qoi, libMesh::System::_qoi_error_estimates, and libMesh::System::n_qois().

Referenced by CoupledSystemQoI::init_qoi_count(), LaplaceQoI::init_qoi_count(), and main().

 {
   _qoi.resize(n_qois);
   _qoi_error_estimates.resize(n_qois);
 }

◆ initialize_eim_assembly_objects()

void libMesh::RBEIMConstruction::initialize_eim_assembly_objects ( )

virtualinherited

Build a vector of ElemAssembly objects that accesses the basis functions stored in this RBEIMConstruction object.

This is useful for performing the Offline stage of the Reduced Basis method where we want to use assembly functions based on this EIM approximation.

Definition at line 1153 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rb_eim_assembly_objects, libMesh::RBEIMConstruction::build_eim_assembly(), libMesh::RBEIMConstruction::get_rb_eim_evaluation(), and libMesh::make_range().

Referenced by main().

 {
   _rb_eim_assembly_objects.clear();
   for (auto i : make_range(get_rb_eim_evaluation().get_n_basis_functions()))
     _rb_eim_assembly_objects.push_back(build_eim_assembly(i));
 }

◆ initialize_eim_construction()

void libMesh::RBEIMConstruction::initialize_eim_construction ( )

inherited

Perform initialization of this object to prepare for running train_eim_approximation().

Definition at line 226 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::initialize_parametrized_functions_in_training_set().

Referenced by main().

 {
   initialize_parametrized_functions_in_training_set();
 }

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

Parameter ranges are inclusive. The input min/max RBParameters should have exactly 1 sample each. Vector-valued samples are not currently supported for the min/max parameters or for discrete parameters.

Definition at line 53 of file rb_parametrized.C.

References libMesh::RBParametrized::_discrete_parameter_values, libMesh::RBParameters::begin_serialized(), libMesh::RBParameters::end_serialized(), libMesh::RBParameters::n_parameters(), libMesh::RBParameters::n_samples(), libMesh::Quality::name(), libMesh::RBParametrized::parameters_initialized, libMesh::RBParametrized::parameters_max, libMesh::RBParametrized::parameters_min, libMesh::Real, libMesh::RBParametrized::set_parameters(), and libMesh::RBParameters::set_value().

Referenced by libMesh::RBConstruction::enrich_basis_from_rhs_terms(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBDataDeserialization::load_parameter_ranges(), libMesh::RBSCMConstruction::perform_SCM_greedy(), libMesh::RBSCMConstruction::process_parameters_file(), libMesh::RBParametrized::read_parameter_data_from_files(), libMesh::RBEIMConstruction::set_rb_construction_parameters(), libMesh::RBConstruction::set_rb_construction_parameters(), RBParametersTest::testRBParametrized(), libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), libMesh::RBEIMConstruction::train_eim_approximation_with_POD(), libMesh::RBConstruction::train_reduced_basis_with_greedy(), and libMesh::RBConstruction::train_reduced_basis_with_POD().

 {
   // Check that the min/max vectors have the same size.
   libmesh_error_msg_if(mu_min_in.n_parameters() != mu_max_in.n_parameters(),
                        "Error: Invalid mu_min/mu_max in initialize_parameters(), different number of parameters.");
   libmesh_error_msg_if(mu_min_in.n_samples() != 1 ||
                        mu_max_in.n_samples() != 1,
                        "Error: Invalid mu_min/mu_max in initialize_parameters(), only 1 sample supported.");
 
   // Ensure all the values are valid for min and max.
   auto pr_min = mu_min_in.begin_serialized();
   auto pr_max = mu_max_in.begin_serialized();
   for (; pr_min != mu_min_in.end_serialized(); ++pr_min, ++pr_max)
     libmesh_error_msg_if((*pr_min).second > (*pr_max).second,
                          "Error: Invalid mu_min/mu_max in RBParameters constructor.");
 
   parameters_min = mu_min_in;
   parameters_max = mu_max_in;
 
   // Add in min/max values due to the discrete parameters
   for (const auto & [name, vals] : discrete_parameter_values)
     {
       libmesh_error_msg_if(vals.empty(), "Error: List of discrete parameters for " << name << " is empty.");
 
       Real min_val = *std::min_element(vals.begin(), vals.end());
       Real max_val = *std::max_element(vals.begin(), vals.end());
 
       libmesh_assert_less_equal(min_val, max_val);
 
       parameters_min.set_value(name, min_val);
       parameters_max.set_value(name, max_val);
     }
 
     _discrete_parameter_values = discrete_parameter_values;
 
   parameters_initialized = true;
 
   // Initialize the current parameters to parameters_min
   set_parameters(parameters_min);
 }

◆ initialize_parameters() [2/2]

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

inherited

Initialize the parameter ranges and set current_parameters.

Definition at line 96 of file rb_parametrized.C.

References libMesh::RBParametrized::get_discrete_parameter_values(), libMesh::RBParametrized::get_parameters_max(), libMesh::RBParametrized::get_parameters_min(), and libMesh::RBParametrized::initialize_parameters().

 {
   initialize_parameters(rb_parametrized.get_parameters_min(),
                         rb_parametrized.get_parameters_max(),
                         rb_parametrized.get_discrete_parameter_values());
 }

◆ initialize_training_parameters()

void libMesh::RBConstructionBase< System >::initialize_training_parameters	(	const RBParameters &	mu_min,
		const RBParameters &	mu_max,
		const unsigned int	n_global_training_samples,
		const std::map< std::string, bool > &	log_param_scale,
		const 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.

n_global_training_samples is the total number of samples to generate, which will be distributed across all the processors.

Definition at line 292 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   if (!is_quiet())
     {
       // Print out some info about the training set initialization
       libMesh::out << "Initializing training parameters with "
                   << (deterministic ? "deterministic " : "random " )
                   << "training set..." << std::endl;
 
       for (const auto & pr : log_param_scale)
         libMesh::out << "Parameter "
                      << pr.first
                      << ": log scaling = "
                      << pr.second
                      << std::endl;
 
       libMesh::out << std::endl;
     }
 
   if (deterministic)
     {
       const auto [first_local_index, last_local_index] =
         generate_training_parameters_deterministic(this->comm(),
                                                    log_param_scale,
                                                    _training_parameters,
                                                    n_global_training_samples,
                                                    mu_min,
                                                    mu_max,
                                                    serial_training_set);
       _first_local_index = first_local_index;
       _n_local_training_samples = last_local_index-first_local_index;
     }
   else
     {
       // Generate random training samples for all parameters
       const auto [first_local_index, last_local_index] =
         generate_training_parameters_random(this->comm(),
                                             log_param_scale,
                                             _training_parameters,
                                             n_global_training_samples,
                                             mu_min,
                                             mu_max,
                                             this->_training_parameters_random_seed,
                                             serial_training_set);
       _first_local_index = first_local_index;
       _n_local_training_samples = last_local_index-first_local_index;
     }
   _n_global_training_samples = _n_local_training_samples;
 
   if (!serial_training_set)
     this->comm().sum(_n_global_training_samples);
 
   // For each parameter that only allows discrete values, we "snap" to the nearest
   // allowable discrete value
   if (get_n_discrete_params() > 0)
     {
       for (auto & [param_name, sample_vector] : _training_parameters)
         {
           if (is_discrete_parameter(param_name))
             {
               const std::vector<Real> & discrete_values =
                 libmesh_map_find(get_discrete_parameter_values(), param_name);
 
               for (const auto sample_idx : index_range(sample_vector))
                 {
                   // Round all values to the closest discrete value.
                   std::vector<Real> discretized_vector(sample_vector[sample_idx].size());
                   std::transform(sample_vector[sample_idx].cbegin(),
                                  sample_vector[sample_idx].cend(),
                                  discretized_vector.begin(),
                                  [&discrete_values](const Real & val) {
                                    return get_closest_value(val, discrete_values);
                                  });
                   sample_vector[sample_idx] = discretized_vector;
                 }
             }
         }
     }
 
   _training_parameters_initialized = true;
 }

◆ is_adjoint_already_solved()

bool libMesh::System::is_adjoint_already_solved ( ) const

inlineinherited

Accessor for the adjoint_already_solved boolean.

Definition at line 411 of file system.h.

References libMesh::System::adjoint_already_solved.

Referenced by libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::AdjointResidualErrorEstimator::estimate_error(), libMesh::ImplicitSystem::qoi_parameter_hessian(), and libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product().

412 { 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:2332

◆ is_discrete_parameter()

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

inherited

Is parameter mu_name discrete?

Definition at line 351 of file rb_parametrized.C.

References libMesh::RBParametrized::_discrete_parameter_values, and libMesh::RBParametrized::parameters_initialized.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), libMesh::RBEIMConstruction::print_info(), libMesh::RBConstruction::print_info(), and libMesh::RBParametrized::write_parameter_ranges_to_file().

 {
   libmesh_error_msg_if(!parameters_initialized,
                        "Error: parameters not initialized in RBParametrized::is_discrete_parameter");
 
   return _discrete_parameter_values.count(mu_name);
 }

◆ is_initialized()

bool libMesh::System::is_initialized ( ) const

inlineinherited

Returns: true iff this system has been initialized.

Definition at line 2457 of file system.h.

References libMesh::System::_is_initialized.

Referenced by libMesh::DofMap::add_variable(), libMesh::DofMap::add_variables(), libMesh::System::get_info(), libMesh::System::init(), and libMesh::StaticCondensationDofMap::reinit().

 {
   return _is_initialized;
 }

◆ is_quiet()

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

inlineinherited

Is the system in quiet mode?

Definition at line 106 of file rb_construction_base.h.

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

107 { return this->quiet_mode; }

libMesh::RBConstructionBase< System >::quiet_mode

bool quiet_mode

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

Definition: rb_construction_base.h:265

◆ load_training_set()

void libMesh::RBConstructionBase< System >::load_training_set ( const std::map< std::string, std::vector< RBParameter >> & new_training_set )

virtualinherited

Overwrite the training parameters with new_training_set.

This training set is assumed to contain only the samples local to this processor.

Definition at line 379 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   // Make sure we're running this on all processors at the same time
   libmesh_parallel_only(this->comm());
 
   // First, make sure that an initial training set has already been generated
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: load_training_set cannot be used to initialize parameters");
 
   // Make sure that the training set has the correct number of parameters
   const unsigned int n_params = get_n_params();
   libmesh_error_msg_if(new_training_set.size() > n_params,
                        "Error: new_training_set should not have more than get_n_params() parameters.");
 
   // Check that (new_training_set.size() == get_n_params()) is the same on all processes so that
   // we go into the same branch of the "if" statement below on all processes.
   const bool size_matches = (new_training_set.size() == n_params);
   libmesh_assert(this->comm().verify(size_matches));
 
   if (size_matches)
     {
       // If new_training_set stores values for all parameters, then we overwrite
       // _training_parameters with new_training_set.
 
       // Get the number of local and global training parameters
       _first_local_index = 0;
       _n_local_training_samples =
         cast_int<numeric_index_type>(new_training_set.begin()->second.size());
       _n_global_training_samples = _n_local_training_samples;
 
       if (!serial_training_set)
         {
           this->comm().sum(_n_global_training_samples);
 
           // Set the first/last indices.
           std::vector<numeric_index_type> local_sizes (this->n_processors(), 0);
           local_sizes[this->processor_id()] = _n_local_training_samples;
           this->comm().sum(local_sizes);
 
           // first_local_index is the sum of local_sizes
           // for all processor ids less than ours
           for (auto p : make_range(this->processor_id()))
             _first_local_index += local_sizes[p];
         }
 
       // Ensure that the parameters are the same.
       for (const auto & pr : _training_parameters)
         libmesh_error_msg_if(!new_training_set.count(pr.first),
                              "Parameters must be identical in order to overwrite dataset.");
 
       // Copy the values from the new_training_set to the internal training_parameters.
       _training_parameters = new_training_set;
     }
   else
     {
       // If new_training_set stores values for a subset of the parameters, then we keep the
       // length of training_parameters unchanged and overwrite the entries of the specified
       // parameters from new_training_set. Note that we repeatedly loop over new_training_set
       // to fill up the entire length of the sample_vector.
       for (auto & [param_name, sample_vector]: _training_parameters)
         {
           if (new_training_set.count(param_name))
             {
               for (const auto i : make_range(get_local_n_training_samples()))
                 {
                   const unsigned int num_new_samples = libmesh_map_find(new_training_set,param_name).size();
                   libmesh_error_msg_if (num_new_samples==0, "new_training_set set should not be empty");
 
                   const unsigned int new_training_set_index = i % num_new_samples;
                   sample_vector[i] = libmesh_map_find(new_training_set,param_name)[new_training_set_index];
                 }
             }
         }
     }
 }

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

Definition at line 1409 of file system.C.

References libMesh::DofMap::dof_indices(), libMesh::DofMapBase::end_dof(), libMesh::DofMapBase::first_dof(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), and libMesh::libmesh_assert().

Referenced by libMesh::System::discrete_var_norm(), SystemsTest::testBlockRestrictedVarNDofs(), and libMesh::DirectSolutionTransfer::transfer().

 {
   // Make sure the set is clear
   var_indices.clear();
 
   std::vector<dof_id_type> dof_indices;
 
   const dof_id_type
     first_local = this->get_dof_map().first_dof(),
     end_local   = this->get_dof_map().end_dof();
 
   // Begin the loop over the elements
   for (const auto & elem : this->get_mesh().active_local_element_ptr_range())
     {
       this->get_dof_map().dof_indices (elem, dof_indices, var);
 
       for (dof_id_type dof : dof_indices)
         //If the dof is owned by the local processor
         if (first_local <= dof && dof < end_local)
           var_indices.insert(dof);
     }
 
   // we may have missed assigning DOFs to nodes that we own
   // but to which we have no connected elements matching our
   // variable restriction criterion.  this will happen, for example,
   // if variable V is restricted to subdomain S.  We may not own
   // any elements which live in S, but we may own nodes which are
   // *connected* to elements which do.
   for (const auto & node : this->get_mesh().local_node_ptr_range())
     {
       libmesh_assert(node);
       this->get_dof_map().dof_indices (node, dof_indices, var);
       for (auto dof : dof_indices)
         if (first_local <= dof && dof < end_local)
           var_indices.insert(dof);
     }
 }

◆ matrices_begin() [1/2]

System::matrices_iterator libMesh::System::matrices_begin ( )

inlineinherited

Beginning of matrices container.

Definition at line 2529 of file system.h.

References libMesh::System::_matrices.

 {
   return _matrices.begin();
 }

◆ matrices_begin() [2/2]

System::const_matrices_iterator libMesh::System::matrices_begin ( ) const

inlineinherited

Beginning of matrices container.

Definition at line 2535 of file system.h.

References libMesh::System::_matrices.

 {
   return _matrices.begin();
 }

◆ matrices_end() [1/2]

System::matrices_iterator libMesh::System::matrices_end ( )

inlineinherited

End of matrices container.

Definition at line 2541 of file system.h.

References libMesh::System::_matrices.

 {
   return _matrices.end();
 }

◆ matrices_end() [2/2]

System::const_matrices_iterator libMesh::System::matrices_end ( ) const

inlineinherited

End of matrices container.

Definition at line 2547 of file system.h.

References libMesh::System::_matrices.

 {
   return _matrices.end();
 }

◆ n_active_dofs()

dof_id_type libMesh::System::n_active_dofs ( ) const

inlineinherited

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

Definition at line 2483 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 2694 of file system.C.

References libMesh::System::get_dof_map(), libMesh::System::get_mesh(), and libMesh::DofMap::n_components().

 {
   return this->get_dof_map().n_components(this->get_mesh());
 }

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

Definition at line 125 of file system.C.

References libMesh::System::_dof_map.

Referenced by form_functionA(), form_functionB(), form_matrixA(), libMesh::System::get_info(), libMesh::System::n_active_dofs(), libMesh::EigenSystem::solve(), and BoundaryInfoTest::testShellFaceConstraints().

 {
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
 
   return _dof_map->n_constrained_dofs();
 
 #else
 
   return 0;
 
 #endif
 }

◆ n_dofs()

dof_id_type libMesh::System::n_dofs ( ) const

inherited

Returns: The number of degrees of freedom in the system

Definition at line 118 of file system.C.

References libMesh::System::_dof_map.

 {
   return _dof_map->n_dofs();
 }

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

Definition at line 140 of file system.C.

References libMesh::System::_dof_map.

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

 {
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
 
   return _dof_map->n_local_constrained_dofs();
 
 #else
 
   return 0;
 
 #endif
 }

◆ n_local_dofs()

dof_id_type libMesh::System::n_local_dofs ( ) const

inherited

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

Definition at line 155 of file system.C.

References libMesh::System::_dof_map.

 {
   return _dof_map->n_local_dofs();
 }

◆ n_matrices()

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

inlineinherited

Returns: The number of matrices handled by this system. This is the size of the _matrices map

Definition at line 2638 of file system.h.

References libMesh::System::_matrices.

Referenced by libMesh::ImplicitSystem::add_matrices(), and libMesh::System::get_info().

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

◆ n_objects() [1/2]

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

inlinestaticinherited

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

Definition at line 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

◆ n_objects() [2/2]

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

inlinestaticinherited

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

Definition at line 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 103 of file parallel_object.h.

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

   {
     processor_id_type returnval =
       cast_int<processor_id_type>(_communicator.size());
     libmesh_assert(returnval); // We never have an empty comm
     return returnval;
   }

◆ n_qois()

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

inlineinherited

Number of currently active quantities of interest.

Definition at line 2562 of file system.h.

References libMesh::System::_qoi, and libMesh::System::_qoi_error_estimates.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::ImplicitSystem::adjoint_solve(), libMesh::SensitivityData::allocate_data(), libMesh::SensitivityData::allocate_hessian_data(), libMesh::ExplicitSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi(), libMesh::ExplicitSystem::assemble_qoi_derivative(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::DiffContext::DiffContext(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::AdjointResidualErrorEstimator::estimate_error(), libMesh::FileSolutionHistory::FileSolutionHistory(), libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), libMesh::UnsteadySolver::init_adjoints(), libMesh::TimeSolver::init_adjoints(), libMesh::System::init_qois(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), main(), libMesh::FEMContext::pre_fe_reinit(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), libMesh::FileSolutionHistory::retrieve(), libMesh::QoISet::size(), libMesh::UnsteadySolver::UnsteadySolver(), and libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

 {
   libmesh_assert_equal_to(this->_qoi.size(), this->_qoi_error_estimates.size());
 
   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 2699 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::n_variable_groups().

Referenced by libMesh::FEMSystem::assembly(), and libMesh::System::get_info().

 {
   return this->get_dof_map().n_variable_groups();
 }

◆ n_vars()

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

inherited

Returns: The number of variables in the system

Definition at line 2674 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::n_vars().

 {
   return this->get_dof_map().n_vars();
 }

◆ n_vectors()

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

inlineinherited

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 2499 of file system.h.

References libMesh::System::_vectors.

Referenced by libMesh::ExplicitSystem::add_system_rhs(), libMesh::System::compare(), libMesh::System::get_info(), main(), libMesh::InterMeshProjection::project_system_vectors(), and libMesh::System::write_header().

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

◆ name()

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

inlineinherited

Returns: The system name.

Definition at line 2385 of file system.h.

References libMesh::System::_sys_name.

Referenced by libMesh::System::compare(), compute_jacobian(), compute_residual(), DMlibMeshSetUpName_Private(), libMesh::RBConstruction::enrich_basis_from_rhs_terms(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::ExactSolution::ExactSolution(), libMesh::ExactErrorEstimator::find_squared_element_error(), libMesh::System::get_info(), libMesh::NewtonSolver::init(), libMesh::StaticCondensation::init(), libMesh::TimeSolver::init_data(), libMesh::System::init_matrices(), main(), output_norms(), libMesh::petsc_auto_fieldsplit(), libMesh::System::prefix(), libMesh::RBSCMConstruction::print_info(), libMesh::ClawSystem::print_info(), libMesh::RBEIMConstruction::print_info(), libMesh::RBConstruction::print_info(), libMesh::TimeSolver::reinit(), libMesh::PetscDiffSolver::setup_petsc_data(), libMesh::FrequencySystem::solve(), libMesh::RBConstruction::truth_solve(), libMesh::System::user_assembly(), libMesh::System::user_constrain(), libMesh::System::user_initialization(), libMesh::System::user_QOI(), libMesh::System::user_QOI_derivative(), libMesh::System::write_header(), libMesh::System::write_parallel_data(), and libMesh::System::write_serialized_data().

 {
   return _sys_name;
 }

◆ number()

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

inlineinherited

Returns: The system number.

Definition at line 2393 of file system.h.

References libMesh::System::_sys_number.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::PetscDMWrapper::add_dofs_helper(), assemble_matrix_and_rhs(), assemble_shell(), libMesh::VariationalSmootherSystem::assembly(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::VariationalSmootherConstraint::constrain_node_to_line(), libMesh::VariationalSmootherConstraint::constrain_node_to_plane(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ExactErrorEstimator::find_squared_element_error(), libMesh::EquationSystems::find_variable_numbers(), libMesh::VariationalSmootherConstraint::fix_node(), libMesh::System::get_info(), libMesh::VariationalSmootherSystem::init_data(), main(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::System::read_parallel_data(), libMesh::System::read_serialized_blocked_dof_objects(), libMesh::StaticCondensationDofMap::reinit(), LinearElasticityWithContact::residual_and_jacobian(), SolidSystem::save_initial_mesh(), libMesh::HPCoarsenTest::select_refinement(), libMesh::PetscPreconditioner< T >::set_hypre_ads_data(), libMesh::PetscPreconditioner< T >::set_hypre_ams_data(), libMesh::PetscDMWrapper::set_point_range_in_section(), MeshInputTest::testCopyElementVectorImpl(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::MeshfreeSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), libMesh::DTKAdapter::update_variable_values(), libMesh::System::write_parallel_data(), libMesh::System::write_serialized_blocked_dof_objects(), and libMesh::System::zero_variable().

 {
   return _sys_number;
 }

◆ point_gradient() [1/4]

Gradient libMesh::System::point_gradient	(	unsigned int	var,
		const Point &	p,
		const bool	insist_on_success = `true`,
		const NumericVector< Number > *	sol = `nullptr`
	)		const

inherited

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

Definition at line 2348 of file system.C.

References libMesh::Variable::active_subdomains(), TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::PointLocatorBase::enable_out_of_mesh_mode(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::libmesh_assert(), mesh, TIMPI::Communicator::min(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::processor_id(), libMesh::DofObject::processor_id(), and libMesh::System::variable().

Referenced by line_print(), and libMesh::System::point_gradient().

 {
   // This function must be called on every processor; there's no
   // telling where in the partition p falls.
   parallel_object_only();
 
   // And every processor had better agree about which point we're
   // looking for
 #ifndef NDEBUG
   libmesh_assert(this->comm().verify(p(0)));
 #if LIBMESH_DIM > 1
   libmesh_assert(this->comm().verify(p(1)));
 #endif
 #if LIBMESH_DIM > 2
   libmesh_assert(this->comm().verify(p(2)));
 #endif
 #endif // NDEBUG
 
   // Get a reference to the mesh object associated with the system object that calls this function
   const MeshBase & mesh = this->get_mesh();
 
   // Use an existing PointLocator or create a new one
   std::unique_ptr<PointLocatorBase> locator_ptr = mesh.sub_point_locator();
   PointLocatorBase & locator = *locator_ptr;
 
   if (!insist_on_success || !mesh.is_serial())
     locator.enable_out_of_mesh_mode();
 
   // Get a pointer to an element that contains p and allows us to
   // evaluate var
   const std::set<subdomain_id_type> & raw_subdomains =
     this->variable(var).active_subdomains();
   const std::set<subdomain_id_type> * implicit_subdomains =
     raw_subdomains.empty() ? nullptr : &raw_subdomains;
   const Elem * e = locator(p, implicit_subdomains);
 
   Gradient grad_u;
 
   if (e && this->get_dof_map().is_evaluable(*e, var))
     grad_u = point_gradient(var, p, *e, sol);
 
   // If I have an element containing p, then let's let everyone know
   processor_id_type lowest_owner =
     (e && (e->processor_id() == this->processor_id())) ?
     this->processor_id() : this->n_processors();
   this->comm().min(lowest_owner);
 
   // Everybody should get their value from a processor that was able
   // to compute it.
   // If nobody admits owning the point, we may have a problem.
   if (lowest_owner != this->n_processors())
     this->comm().broadcast(grad_u, lowest_owner);
   else
     libmesh_assert(!insist_on_success);
 
   return grad_u;
 }

◆ point_gradient() [2/4]

Gradient libMesh::System::point_gradient	(	unsigned int	var,
		const Point &	p,
		const Elem &	e,
		const NumericVector< Number > *	sol = `nullptr`
	)		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.

Definition at line 2410 of file system.C.

References libMesh::FEInterface::compute_data(), libMesh::Elem::contains_point(), libMesh::System::current_local_solution, dim, libMesh::Elem::dim(), libMesh::DofMap::dof_indices(), libMesh::FEComputeData::dshape, libMesh::FEComputeData::enable_derivative(), libMesh::System::get_dof_map(), libMesh::System::get_equation_systems(), libMesh::FEMap::inverse_map(), libMesh::DofMap::is_evaluable(), libMesh::libmesh_assert(), libMesh::FEComputeData::local_transform, and libMesh::DofMap::variable_type().

 {
   // Ensuring that the given point is really in the element is an
   // expensive assert, but as long as debugging is turned on we might
   // as well try to catch a particularly nasty potential error
   libmesh_assert (e.contains_point(p));
 
   if (!sol)
     sol = this->current_local_solution.get();
 
   // Get the dof map to get the proper indices for our computation
   const DofMap & dof_map = this->get_dof_map();
 
   // write the element dimension into a separate variable.
   const unsigned int dim = e.dim();
 
   // Make sure we can evaluate on this element.
   libmesh_assert (dof_map.is_evaluable(e, var));
 
   // Need dof_indices for phi[i][j]
   std::vector<dof_id_type> dof_indices;
 
   // Fill in the dof_indices for our element
   dof_map.dof_indices (&e, dof_indices, var);
 
   // Get the no of dofs associated with this point
   const unsigned int num_dofs = cast_int<unsigned int>
     (dof_indices.size());
 
   FEType fe_type = dof_map.variable_type(var);
 
   // Map the physical co-ordinates to the master co-ordinates
   Point coor = FEMap::inverse_map(dim, &e, p);
 
   // get the shape function value via the FEInterface to also handle the case
   // of infinite elements correctly, the shape function is not fe->phi().
   FEComputeData fe_data(this->get_equation_systems(), coor);
   fe_data.enable_derivative();
   FEInterface::compute_data(dim, fe_type, &e, fe_data);
 
   // Get ready to accumulate a gradient
   Gradient grad_u;
 
   for (unsigned int l=0; l<num_dofs; l++)
     {
       // Chartesian coordinates have always LIBMESH_DIM entries,
       // local coordinates have as many coordinates as the element has.
       for (std::size_t v=0; v<dim; v++)
         for (std::size_t xyz=0; xyz<LIBMESH_DIM; xyz++)
           {
             // FIXME: this needs better syntax: It is matrix-vector multiplication.
             grad_u(xyz) += fe_data.local_transform[v][xyz]
               * fe_data.dshape[l](v)
               * (*sol)(dof_indices[l]);
           }
     }
 
   return grad_u;
 }

◆ point_gradient() [3/4]

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.

Definition at line 2475 of file system.C.

References libMesh::libmesh_assert(), and libMesh::System::point_gradient().

 {
   libmesh_assert(e);
   return this->point_gradient(var, p, *e);
 }

◆ point_gradient() [4/4]

Gradient libMesh::System::point_gradient	(	unsigned int	var,
		const Point &	p,
		const NumericVector< Number > *	sol
	)		const

inherited

Calls the parallel version of point_gradient().

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

Definition at line 2483 of file system.C.

References libMesh::System::point_gradient().

 {
   return this->point_gradient(var, p, true, sol);
 }

◆ point_hessian() [1/4]

Tensor libMesh::System::point_hessian	(	unsigned int	var,
		const Point &	p,
		const bool	insist_on_success = `true`,
		const NumericVector< Number > *	sol = `nullptr`
	)		const

inherited

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

Definition at line 2492 of file system.C.

References libMesh::Variable::active_subdomains(), TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::PointLocatorBase::enable_out_of_mesh_mode(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::libmesh_assert(), mesh, TIMPI::Communicator::min(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::processor_id(), libMesh::DofObject::processor_id(), and libMesh::System::variable().

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

 {
   // This function must be called on every processor; there's no
   // telling where in the partition p falls.
   parallel_object_only();
 
   // And every processor had better agree about which point we're
   // looking for
 #ifndef NDEBUG
   libmesh_assert(this->comm().verify(p(0)));
 #if LIBMESH_DIM > 1
   libmesh_assert(this->comm().verify(p(1)));
 #endif
 #if LIBMESH_DIM > 2
   libmesh_assert(this->comm().verify(p(2)));
 #endif
 #endif // NDEBUG
 
   // Get a reference to the mesh object associated with the system object that calls this function
   const MeshBase & mesh = this->get_mesh();
 
   // Use an existing PointLocator or create a new one
   std::unique_ptr<PointLocatorBase> locator_ptr = mesh.sub_point_locator();
   PointLocatorBase & locator = *locator_ptr;
 
   if (!insist_on_success || !mesh.is_serial())
     locator.enable_out_of_mesh_mode();
 
   // Get a pointer to an element that contains p and allows us to
   // evaluate var
   const std::set<subdomain_id_type> & raw_subdomains =
     this->variable(var).active_subdomains();
   const std::set<subdomain_id_type> * implicit_subdomains =
     raw_subdomains.empty() ? nullptr : &raw_subdomains;
   const Elem * e = locator(p, implicit_subdomains);
 
   Tensor hess_u;
 
   if (e && this->get_dof_map().is_evaluable(*e, var))
     hess_u = point_hessian(var, p, *e, sol);
 
   // If I have an element containing p, then let's let everyone know
   processor_id_type lowest_owner =
     (e && (e->processor_id() == this->processor_id())) ?
     this->processor_id() : this->n_processors();
   this->comm().min(lowest_owner);
 
   // Everybody should get their value from a processor that was able
   // to compute it.
   // If nobody admits owning the point, we may have a problem.
   if (lowest_owner != this->n_processors())
     this->comm().broadcast(hess_u, lowest_owner);
   else
     libmesh_assert(!insist_on_success);
 
   return hess_u;
 }

◆ point_hessian() [2/4]

Tensor libMesh::System::point_hessian	(	unsigned int	var,
		const Point &	p,
		const Elem &	e,
		const NumericVector< Number > *	sol = `nullptr`
	)		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.

Definition at line 2553 of file system.C.

References libMesh::TypeTensor< T >::add_scaled(), libMesh::FEGenericBase< OutputType >::build(), libMesh::Elem::contains_point(), libMesh::System::current_local_solution, libMesh::Elem::dim(), libMesh::DofMap::dof_indices(), libMesh::System::get_dof_map(), libMesh::Elem::infinite(), libMesh::FEMap::inverse_map(), libMesh::DofMap::is_evaluable(), libMesh::libmesh_assert(), and libMesh::DofMap::variable_type().

 {
   // Ensuring that the given point is really in the element is an
   // expensive assert, but as long as debugging is turned on we might
   // as well try to catch a particularly nasty potential error
   libmesh_assert (e.contains_point(p));
 
   if (!sol)
     sol = this->current_local_solution.get();
 
   if (e.infinite())
     libmesh_not_implemented();
 
   // Get the dof map to get the proper indices for our computation
   const DofMap & dof_map = this->get_dof_map();
 
   // Make sure we can evaluate on this element.
   libmesh_assert (dof_map.is_evaluable(e, var));
 
   // Need dof_indices for phi[i][j]
   std::vector<dof_id_type> dof_indices;
 
   // Fill in the dof_indices for our element
   dof_map.dof_indices (&e, dof_indices, var);
 
   // Get the no of dofs associated with this point
   const unsigned int num_dofs = cast_int<unsigned int>
     (dof_indices.size());
 
   FEType fe_type = dof_map.variable_type(var);
 
   // Build a FE again so we can calculate u(p)
   std::unique_ptr<FEBase> fe (FEBase::build(e.dim(), fe_type));
 
   // Map the physical co-ordinates to the master co-ordinates
   // Build a vector of point co-ordinates to send to reinit
   std::vector<Point> coor(1, FEMap::inverse_map(e.dim(), &e, p));
 
   // Get the values of the shape function derivatives
   const std::vector<std::vector<RealTensor>> &  d2phi = fe->get_d2phi();
 
   // Reinitialize the element and compute the shape function values at coor
   fe->reinit (&e, &coor);
 
   // Get ready to accumulate a hessian
   Tensor hess_u;
 
   for (unsigned int l=0; l<num_dofs; l++)
     {
       hess_u.add_scaled (d2phi[l][0], (*sol)(dof_indices[l]));
     }
 
   return hess_u;
 }

◆ point_hessian() [3/4]

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.

Definition at line 2613 of file system.C.

References libMesh::libmesh_assert(), and libMesh::System::point_hessian().

 {
   libmesh_assert(e);
   return this->point_hessian(var, p, *e);
 }

◆ point_hessian() [4/4]

Tensor libMesh::System::point_hessian	(	unsigned int	var,
		const Point &	p,
		const NumericVector< Number > *	sol
	)		const

inherited

Calls the parallel version of point_hessian().

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

Definition at line 2621 of file system.C.

References libMesh::System::point_hessian().

 {
   return this->point_hessian(var, p, true, sol);
 }

◆ point_value() [1/4]

Number libMesh::System::point_value	(	unsigned int	var,
		const Point &	p,
		const bool	insist_on_success = `true`,
		const NumericVector< Number > *	sol = `nullptr`
	)		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, using the degree of freedom coefficients in sol (or in current_local_solution if sol is left null).

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.

Definition at line 2219 of file system.C.

References libMesh::Variable::active_subdomains(), TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::PointLocatorBase::enable_out_of_mesh_mode(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::libmesh_assert(), mesh, TIMPI::Communicator::min(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::processor_id(), libMesh::DofObject::processor_id(), and libMesh::System::variable().

Referenced by line_print(), main(), libMesh::System::point_value(), MeshInputTest::testCopyElementSolutionImpl(), MeshInputTest::testCopyElementVectorImpl(), MeshInputTest::testCopyNodalSolutionImpl(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData(), PeriodicBCTest::testPeriodicBC(), SystemsTest::testProjectCubeWithMeshFunction(), EquationSystemsTest::testRepartitionThenReinit(), DisjointNeighborTest::testTempJump(), and DisjointNeighborTest::testTempJumpRefine().

 {
   // This function must be called on every processor; there's no
   // telling where in the partition p falls.
   parallel_object_only();
 
   // And every processor had better agree about which point we're
   // looking for
 #ifndef NDEBUG
   libmesh_assert(this->comm().verify(p(0)));
 #if LIBMESH_DIM > 1
   libmesh_assert(this->comm().verify(p(1)));
 #endif
 #if LIBMESH_DIM > 2
   libmesh_assert(this->comm().verify(p(2)));
 #endif
 #endif // NDEBUG
 
   // Get a reference to the mesh object associated with the system object that calls this function
   const MeshBase & mesh = this->get_mesh();
 
   // Use an existing PointLocator or create a new one
   std::unique_ptr<PointLocatorBase> locator_ptr = mesh.sub_point_locator();
   PointLocatorBase & locator = *locator_ptr;
 
   if (!insist_on_success || !mesh.is_serial())
     locator.enable_out_of_mesh_mode();
 
   // Get a pointer to an element that contains p and allows us to
   // evaluate var
   const std::set<subdomain_id_type> & raw_subdomains =
     this->variable(var).active_subdomains();
   const std::set<subdomain_id_type> * implicit_subdomains =
     raw_subdomains.empty() ? nullptr : &raw_subdomains;
   const Elem * e = locator(p, implicit_subdomains);
 
   Number u = 0;
 
   if (e && this->get_dof_map().is_evaluable(*e, var))
     u = point_value(var, p, *e, sol);
 
   // If I have an element containing p, then let's let everyone know
   processor_id_type lowest_owner =
     (e && (e->processor_id() == this->processor_id())) ?
     this->processor_id() : this->n_processors();
   this->comm().min(lowest_owner);
 
   // Everybody should get their value from a processor that was able
   // to compute it.
   // If nobody admits owning the point, we have a problem.
   if (lowest_owner != this->n_processors())
     this->comm().broadcast(u, lowest_owner);
   else
     libmesh_assert(!insist_on_success);
 
   return u;
 }

◆ point_value() [2/4]

Number libMesh::System::point_value	(	unsigned int	var,
		const Point &	p,
		const Elem &	e,
		const NumericVector< Number > *	sol = `nullptr`
	)		const

inherited

Returns: The value of the solution variable var at the physical point p contained in local Elem e, using the degree of freedom coefficients in sol (or in current_local_solution if sol is left null).

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

Definition at line 2280 of file system.C.

References libMesh::FEInterface::compute_data(), libMesh::Elem::contains_point(), libMesh::System::current_local_solution, libMesh::Elem::dim(), libMesh::DofMap::dof_indices(), libMesh::System::get_dof_map(), libMesh::System::get_equation_systems(), libMesh::FEMap::inverse_map(), libMesh::DofMap::is_evaluable(), libMesh::libmesh_assert(), and libMesh::DofMap::variable_type().

 {
   // Ensuring that the given point is really in the element is an
   // expensive assert, but as long as debugging is turned on we might
   // as well try to catch a particularly nasty potential error
   libmesh_assert (e.contains_point(p));
 
   if (!sol)
     sol = this->current_local_solution.get();
 
   // Get the dof map to get the proper indices for our computation
   const DofMap & dof_map = this->get_dof_map();
 
   // Make sure we can evaluate on this element.
   libmesh_assert (dof_map.is_evaluable(e, var));
 
   // Need dof_indices for phi[i][j]
   std::vector<dof_id_type> dof_indices;
 
   // Fill in the dof_indices for our element
   dof_map.dof_indices (&e, dof_indices, var);
 
   // Get the no of dofs associated with this point
   const unsigned int num_dofs = cast_int<unsigned int>
     (dof_indices.size());
 
   FEType fe_type = dof_map.variable_type(var);
 
   // Map the physical co-ordinates to the master co-ordinates
   Point coor = FEMap::inverse_map(e.dim(), &e, p);
 
   // get the shape function value via the FEInterface to also handle the case
   // of infinite elements correctly, the shape function is not fe->phi().
   FEComputeData fe_data(this->get_equation_systems(), coor);
   FEInterface::compute_data(e.dim(), fe_type, &e, fe_data);
 
   // Get ready to accumulate a value
   Number u = 0;
 
   for (unsigned int l=0; l<num_dofs; l++)
     {
       u += fe_data.shape[l] * (*sol)(dof_indices[l]);
     }
 
   return u;
 }

◆ point_value() [3/4]

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.

Definition at line 2332 of file system.C.

References libMesh::libmesh_assert(), and libMesh::System::point_value().

 {
   libmesh_assert(e);
   return this->point_value(var, p, *e);
 }

◆ point_value() [4/4]

Number libMesh::System::point_value	(	unsigned int	var,
		const Point &	p,
		const NumericVector< Number > *	sol
	)		const

inherited

Calls the parallel version of point_value().

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

Definition at line 2340 of file system.C.

References libMesh::System::point_value().

 {
   return this->point_value(var, p, true, sol);
 }

◆ prefer_hash_table_matrix_assembly()

void libMesh::System::prefer_hash_table_matrix_assembly ( bool preference )

inlineinherited

Sets whether to use hash table matrix assembly if the matrix sub-classes support it.

Definition at line 2667 of file system.h.

References libMesh::System::_matrices_initialized, and libMesh::System::_prefer_hash_table_matrix_assembly.

Referenced by main().

 {
   libmesh_error_msg_if(
       _matrices_initialized,
       "System::prefer_hash_table_matrix_assembly() should be called before matrices are initialized");
   _prefer_hash_table_matrix_assembly = preference;
 }

◆ prefix()

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

inlineinherited

Returns: A prefix that may be applied to solver options. Note that this prefix is only used if prefix_with_name()

Definition at line 1980 of file system.h.

References libMesh::System::name().

Referenced by libMesh::ImplicitSystem::get_linear_solver(), libMesh::LinearImplicitSystem::solve(), and libMesh::NonlinearImplicitSystem::solve().

1980 { return this->name() + "_"; }

libMesh::System::name

const std::string & name() const

Definition: system.h:2385

◆ prefix_with_name() [1/2]

void libMesh::System::prefix_with_name ( bool value )

inlineinherited

Instructs this system to prefix solve options with its name for solvers that leverage prefixes.

Definition at line 1969 of file system.h.

References libMesh::System::_prefix_with_name, and value.

1969 { _prefix_with_name = value; }

value

static const bool value

Definition: xdr_io.C:55

libMesh::System::_prefix_with_name

bool _prefix_with_name

Whether we are name prefixing solver options.

Definition: system.h:2358

◆ prefix_with_name() [2/2]

bool libMesh::System::prefix_with_name ( ) const

inlineinherited

Returns: Whether we are name prefixing

Definition at line 1974 of file system.h.

References libMesh::System::_prefix_with_name.

Referenced by libMesh::ContinuationSystem::ContinuationSystem(), libMesh::ImplicitSystem::get_linear_solver(), libMesh::LinearImplicitSystem::solve(), libMesh::NonlinearImplicitSystem::solve(), and libMesh::System::System().

1974 { return _prefix_with_name; }

libMesh::System::_prefix_with_name

bool _prefix_with_name

Whether we are name prefixing solver options.

Definition: system.h:2358

◆ print_discrete_parameter_values()

void libMesh::RBParametrized::print_discrete_parameter_values ( ) const

inherited

Print out all the discrete parameter values.

Definition at line 366 of file rb_parametrized.C.

References libMesh::RBParametrized::get_discrete_parameter_values(), libMesh::Quality::name(), libMesh::out, and value.

Referenced by libMesh::RBSCMConstruction::print_info(), libMesh::RBEIMConstruction::print_info(), and libMesh::RBConstruction::print_info().

 {
   for (const auto & [name, values] : get_discrete_parameter_values())
     {
       libMesh::out << "Discrete parameter " << name << ", values: ";
 
       for (const auto & value : values)
         libMesh::out << value << " ";
       libMesh::out << std::endl;
     }
 }

◆ print_info() [1/3]

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

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

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

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

◆ print_info() [2/3]

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

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

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

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

◆ print_info() [3/3]

void libMesh::RBEIMConstruction::print_info ( )

virtualinherited

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

Definition at line 187 of file rb_eim_construction.C.

Referenced by main().

 {
   // Print out info that describes the current setup
   libMesh::out << std::endl << "RBEIMConstruction parameters:" << std::endl;
   libMesh::out << "system name: " << this->name() << std::endl;
   libMesh::out << "Nmax: " << get_Nmax() << std::endl;
   if (_set_Nmax_from_n_snapshots)
   {
     libMesh::out << "Overruling Nmax based on number of snapshots, with increment set to "
       << _Nmax_from_n_snapshots_increment
       << std::endl;
   }
   libMesh::out << "Greedy relative error tolerance: " << get_rel_training_tolerance() << std::endl;
   libMesh::out << "Greedy absolute error tolerance: " << get_abs_training_tolerance() << std::endl;
   libMesh::out << "Number of parameters: " << get_n_params() << std::endl;
   for (const auto & pr : get_parameters())
     if (!is_discrete_parameter(pr.first))
       {
         libMesh::out <<   "Parameter " << pr.first
                      << ": Min = " << get_parameter_min(pr.first)
                      << ", Max = " << get_parameter_max(pr.first) << std::endl;
       }
 
   print_discrete_parameter_values();
   libMesh::out << "n_training_samples: " << get_n_training_samples() << std::endl;
   libMesh::out << "quiet mode? " << is_quiet() << std::endl;
 
   if (best_fit_type_flag == PROJECTION_BEST_FIT)
     {
       libMesh::out << "EIM best fit type: projection" << std::endl;
     }
   else
     if (best_fit_type_flag == EIM_BEST_FIT)
       {
         libMesh::out << "EIM best fit type: eim" << std::endl;
       }
   libMesh::out << std::endl;
 }

◆ print_parameters()

void libMesh::RBParametrized::print_parameters ( ) const

inherited

Print the current parameters.

Definition at line 178 of file rb_parametrized.C.

References libMesh::RBParametrized::get_parameters(), libMesh::RBParametrized::parameters_initialized, and libMesh::RBParameters::print().

Referenced by libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), and libMesh::RBConstruction::train_reduced_basis_with_greedy().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::print_current_parameters");
 
   get_parameters().print();
 }

◆ process_parameters_file()

void libMesh::RBEIMConstruction::process_parameters_file ( const std::string & parameters_filename )

virtualinherited

Read parameters in from file and set up this system accordingly.

Definition at line 231 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_abs_training_tolerance, libMesh::RBEIMConstruction::_Nmax, libMesh::RBEIMConstruction::_rel_training_tolerance, libMesh::make_range(), libMesh::RBConstructionBase< System >::quiet_mode, libMesh::Real, libMesh::RBEIMConstruction::set_best_fit_type_flag(), libMesh::RBEIMConstruction::set_rb_construction_parameters(), and libMesh::RBParameters::set_value().

Referenced by main().

 {
   // First read in data from input_filename
   GetPot infile(parameters_filename);
 
   std::string best_fit_type_string = infile("best_fit_type","projection");
   set_best_fit_type_flag(best_fit_type_string);
 
   const unsigned int n_training_samples = infile("n_training_samples",0);
   const bool deterministic_training = infile("deterministic_training",false);
   unsigned int training_parameters_random_seed_in =
     static_cast<unsigned int>(-1);
   training_parameters_random_seed_in = infile("training_parameters_random_seed",
                                               training_parameters_random_seed_in);
   const bool quiet_mode_in = infile("quiet_mode", quiet_mode);
   const unsigned int Nmax_in = infile("Nmax", _Nmax);
   const Real rel_training_tolerance_in = infile("rel_training_tolerance",
                                                 _rel_training_tolerance);
   const Real abs_training_tolerance_in = infile("abs_training_tolerance",
                                                 _abs_training_tolerance);
 
   // Read in the parameters from the input file too
   unsigned int n_continuous_parameters = infile.vector_variable_size("parameter_names");
   RBParameters mu_min_in;
   RBParameters mu_max_in;
   for (unsigned int i=0; i<n_continuous_parameters; i++)
     {
       // Read in the parameter names
       std::string param_name = infile("parameter_names", "NONE", i);
 
       {
         Real min_val = infile(param_name, 0., 0);
         mu_min_in.set_value(param_name, min_val);
       }
 
       {
         Real max_val = infile(param_name, 0., 1);
         mu_max_in.set_value(param_name, max_val);
       }
     }
 
   std::map<std::string, std::vector<Real>> discrete_parameter_values_in;
 
   unsigned int n_discrete_parameters = infile.vector_variable_size("discrete_parameter_names");
   for (unsigned int i=0; i<n_discrete_parameters; i++)
     {
       std::string param_name = infile("discrete_parameter_names", "NONE", i);
 
       unsigned int n_vals_for_param = infile.vector_variable_size(param_name);
       std::vector<Real> vals_for_param(n_vals_for_param);
       for (auto j : make_range(vals_for_param.size()))
         vals_for_param[j] = infile(param_name, 0., j);
 
       discrete_parameter_values_in[param_name] = vals_for_param;
     }
 
   std::map<std::string,bool> log_scaling_in;
   // For now, just set all entries to false.
   // TODO: Implement a decent way to specify log-scaling true/false
   // in the input text file
   for (const auto & pr : mu_min_in)
     log_scaling_in[pr.first] = false;
 
   // Set the parameters that have been read in
   set_rb_construction_parameters(n_training_samples,
                                  deterministic_training,
                                  training_parameters_random_seed_in,
                                  quiet_mode_in,
                                  Nmax_in,
                                  rel_training_tolerance_in,
                                  abs_training_tolerance_in,
                                  mu_min_in,
                                  mu_max_in,
                                  discrete_parameter_values_in,
                                  log_scaling_in);
 }

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 114 of file parallel_object.h.

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

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

TIMPI::Communicator::rank

processor_id_type rank() const

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:120

◆ project_solution() [1/3]

void libMesh::System::project_solution	(	FunctionBase< Number > *	f,
		FunctionBase< Gradient > *	g = `nullptr`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

inherited

Projects arbitrary functions onto the current solution.

This method projects an arbitrary function onto the solution via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection. variable_numbers variable_numbers, if provided, indicates the variable numbers onto which to project.

Definition at line 1064 of file system_projection.C.

Referenced by init_sys(), initialize(), main(), set_initial_condition(), SlitMeshRefinedSystemTest::setUp(), FETestBase< order, family, elem_type, N_x >::setUp(), MeshFunctionTest::test_bad_gradient_var_with_out_of_mesh_value(), MeshFunctionTest::test_bad_hessian_var_with_out_of_mesh_value(), MeshfunctionDFEM::test_mesh_function_dfem(), MeshfunctionDFEM::test_mesh_function_dfem_grad(), MeshFunctionTest::test_p_level(), ProjectSolutionTest::test_partial_project_solution(), MeshFunctionTest::test_subdomain_id_sets(), MeshInputTest::testCopyElementSolutionImpl(), MeshInputTest::testCopyNodalSolutionImpl(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), SystemsTest::testProjectCubeWithMeshFunction(), MeshInputTest::testProjectionRegression(), EquationSystemsTest::testRepartitionThenReinit(), and libMesh::MeshfreeSolutionTransfer::transfer().

 {
   this->project_vector(*solution, f, g, /*is_adjoint=*/-1, active_local_range, variable_numbers);
 
   solution->localize(*current_local_solution, _dof_map->get_send_list());
 }

◆ project_solution() [2/3]

void libMesh::System::project_solution	(	FEMFunctionBase< Number > *	f,
		FEMFunctionBase< Gradient > *	g = `nullptr`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

inherited

Projects arbitrary functions onto the current solution.

This method projects an arbitrary function onto the solution via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection. variable_numbers variable_numbers, if provided, indicates the variable numbers onto which to project.

Definition at line 1079 of file system_projection.C.

 {
   this->project_vector(*solution, f, g, /*is_adjoint=*/-1, active_local_range, variable_numbers);
 
   solution->localize(*current_local_solution, _dof_map->get_send_list());
 }

◆ project_solution() [3/3]

void libMesh::System::project_solution	(	ValueFunctionPointer	fptr,
		GradientFunctionPointer	gptr,
		const Parameters &	parameters,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

inherited

This method projects an arbitrary function onto the solution via L2 projections and nodal interpolations on each element.

Definition at line 1048 of file system_projection.C.

References fptr(), and gptr().

 {
   WrappedFunction<Number> f(*this, fptr, &function_parameters);
   WrappedFunction<Gradient> g(*this, gptr, &function_parameters);
   this->project_solution(&f, &g, active_local_range, variable_numbers);
 }

◆ project_solution_on_reinit()

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

inlineinherited

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 884 of file system.h.

References libMesh::System::_solution_projection.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), and libMesh::MemoryHistoryData::store_vectors().

885 { 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:2294

◆ project_vector() [1/5]

void libMesh::System::project_vector	(	NumericVector< Number > &	new_vector,
		FunctionBase< Number > *	f,
		FunctionBase< Gradient > *	g = `nullptr`,
		int	is_adjoint = `-1`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

inherited

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

This method projects an arbitrary function via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection. variable_numbers variable_numbers, if provided, indicates the variable numbers onto which to project.

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

Definition at line 1111 of file system_projection.C.

References libMesh::libmesh_assert().

Referenced by main(), libMesh::NewmarkSolver::project_initial_accel(), libMesh::SecondOrderUnsteadySolver::project_initial_rate(), libMesh::InterMeshProjection::project_system_vectors(), and libMesh::System::restrict_vectors().

 {
   LOG_SCOPE ("project_vector(FunctionBase)", "System");
 
   libmesh_assert(f);
 
   WrappedFunctor<Number> f_fem(*f);
 
   if (g)
     {
       WrappedFunctor<Gradient> g_fem(*g);
 
       this->project_vector(new_vector, &f_fem, &g_fem, is_adjoint, active_local_range, variable_numbers);
     }
   else
     this->project_vector(new_vector, &f_fem, nullptr, is_adjoint, active_local_range, variable_numbers);
 }

◆ project_vector() [2/5]

void libMesh::System::project_vector	(	NumericVector< Number > &	new_vector,
		FEMFunctionBase< Number > *	f,
		FEMFunctionBase< Gradient > *	g = `nullptr`,
		int	is_adjoint = `-1`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

inherited

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

This method projects an arbitrary function via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection. variable_numbers variable_numbers, if provided, indicates the variable numbers onto which to project.

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

Definition at line 1139 of file system_projection.C.

References libMesh::NumericVector< T >::close(), libMesh::FEMFunctionBase< Output >::component(), libMesh::FEType::family, libMesh::libmesh_assert(), libMesh::libmesh_ignore(), n_vars, libMesh::NODEELEM, libMesh::FEMContext::pre_fe_reinit(), libMesh::RATIONAL_BERNSTEIN, libMesh::SCALAR, libMesh::DofMap::SCALAR_dof_indices(), libMesh::NumericVector< T >::set(), and libMesh::Variable::type().

 {
   LOG_SCOPE ("project_fem_vector()", "System");
 
   libmesh_assert (f);
 
   if (!active_local_range)
     {
       active_local_range.emplace
         (this->get_mesh().active_local_elements_begin(),
          this->get_mesh().active_local_elements_end());
     }
 
   VectorSetAction<Number> setter(new_vector);
 
   const unsigned int n_variables = this->n_vars();
 
   std::vector<unsigned int> vars;
   if (variable_numbers)
     {
       vars = *variable_numbers;
       for (auto v : vars)
         if (v >= n_variables)
           libmesh_error_msg("ERROR: variable number " << v <<
                            " out of range for system with " <<
                            n_variables << " variables.");
     }
   else
     {
       vars.resize(n_variables);
       std::iota(vars.begin(), vars.end(), 0);
     }
 
 
   // Use a typedef to make the calling sequence for parallel_for() a bit more readable
   typedef
     GenericProjector<FEMFunctionWrapper<Number>, FEMFunctionWrapper<Gradient>,
                      Number, VectorSetAction<Number>> FEMProjector;
 
   FEMFunctionWrapper<Number> fw(*f);
 
   if (g)
     {
       FEMFunctionWrapper<Gradient> gw(*g);
 
       FEMProjector projector(*this, fw, &gw, setter, vars);
       projector.project(active_local_range.value());
     }
   else
     {
       FEMProjector projector(*this, fw, nullptr, setter, vars);
       projector.project(active_local_range.value());
     }
 
   // Also, load values into the SCALAR dofs
   // Note: We assume that all SCALAR dofs are on the
   // processor with highest ID
   if (this->processor_id() == (this->n_processors()-1))
     {
       // FIXME: Do we want to first check for SCALAR vars before building this? [PB]
       FEMContext context( *this );
 
       const DofMap & dof_map = this->get_dof_map();
       for (auto var : vars)
         if (this->variable(var).type().family == SCALAR)
           {
             // FIXME: We reinit with an arbitrary element in case the user
             //        doesn't override FEMFunctionBase::component. Is there
             //        any use case we're missing? [PB]
             context.pre_fe_reinit(*this, *(this->get_mesh().active_local_elements_begin()));
 
             std::vector<dof_id_type> SCALAR_indices;
             dof_map.SCALAR_dof_indices (SCALAR_indices, var);
             const unsigned int n_SCALAR_dofs =
               cast_int<unsigned int>(SCALAR_indices.size());
 
             for (unsigned int i=0; i<n_SCALAR_dofs; i++)
               {
                 const dof_id_type global_index = SCALAR_indices[i];
                 const unsigned int component_index =
                   this->variable_scalar_number(var,i);
 
                 new_vector.set(global_index, f->component(context, component_index, Point(), this->time));
               }
           }
     }
 
   new_vector.close();
 
   // Look for spline bases, in which case we need to backtrack
   // to calculate the spline DoF values.
   std::vector<const Variable *> rational_vars;
   for (auto varnum : vars)
     {
       const Variable & var = this->get_dof_map().variable(varnum);
       if (var.type().family == RATIONAL_BERNSTEIN)
         rational_vars.push_back(&var);
     }
 
   // Okay, but are we really using any *spline* bases, or just
   // unconstrained rational bases?
   bool using_spline_bases = false;
   if (!rational_vars.empty())
     {
       // Look for a spline node: a NodeElem with a rational variable
       // on it.
       for (auto & elem : active_local_range.value())
         if (elem->type() == NODEELEM)
           for (auto rational_var : rational_vars)
             if (rational_var->active_on_subdomain(elem->subdomain_id()))
               {
                 using_spline_bases = true;
                 goto checked_on_splines;
               }
     }
 
 checked_on_splines:
 
   // Not every processor may have a NodeElem, especially while
   // we're not partitioning them efficiently yet.
   this->comm().max(using_spline_bases);
 
   if (using_spline_bases)
     this->solve_for_unconstrained_dofs(new_vector, is_adjoint);
 
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
   if (is_adjoint == -1)
     this->get_dof_map().enforce_constraints_exactly(*this, &new_vector);
   else if (is_adjoint >= 0)
     this->get_dof_map().enforce_adjoint_constraints_exactly(new_vector,
                                                             is_adjoint);
 #else
   libmesh_ignore(is_adjoint);
 #endif
 }

◆ project_vector() [3/5]

void libMesh::System::project_vector	(	ValueFunctionPointer	fptr,
		GradientFunctionPointer	gptr,
		const Parameters &	parameters,
		NumericVector< Number > &	new_vector,
		int	is_adjoint = `-1`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

inherited

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

This method projects an arbitrary function via L2 projections and nodal interpolations on each element.

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. elem_range active_local_range, if provided, indicates the range of elements over which to perform the projection. variable_numbers variable_numbers, if provided, indicates the variable numbers onto which to project.

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

Definition at line 1094 of file system_projection.C.

References fptr(), and gptr().

 {
   WrappedFunction<Number> f(*this, fptr, &function_parameters);
   WrappedFunction<Gradient> g(*this, gptr, &function_parameters);
   this->project_vector(new_vector, &f, &g, is_adjoint, active_local_range, variable_numbers);
 }

◆ project_vector() [4/5]

void libMesh::System::project_vector	(	NumericVector< Number > &	vector,
		int	is_adjoint = `-1`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		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.

Definition at line 247 of file system_projection.C.

References libMesh::NumericVector< T >::clone().

 {
   // Create a copy of the vector, which currently
   // contains the old data.
   std::unique_ptr<NumericVector<Number>>
     old_vector (vector.clone());
 
   // Project the old vector to the new vector
   this->project_vector (*old_vector, vector, is_adjoint, active_local_range, variable_numbers);
 }

◆ project_vector() [5/5]

void libMesh::System::project_vector	(	const NumericVector< Number > &	old_v,
		NumericVector< Number > &	new_v,
		int	is_adjoint = `-1`,
		std::optional< ConstElemRange >	active_local_range = `std::nullopt`,
		std::optional< std::vector< unsigned int >>	variable_numbers = `std::nullopt`
	)		const

protectedinherited

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

This method projects the vector via L2 projections or nodal interpolations on each element.

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.

This method projects a solution from an old mesh to a current, refined mesh. The input vector old_v gives the solution on the old mesh, while the new_v gives the solution (to be computed) on the new mesh.

Definition at line 267 of file system_projection.C.

 {
   LOG_SCOPE ("project_vector(old,new)", "System");
 
   new_v.clear();
 
 #ifdef LIBMESH_ENABLE_AMR
 
   // Resize the new vector and get a serial version.
   NumericVector<Number> * new_vector_ptr = nullptr;
   std::unique_ptr<NumericVector<Number>> new_vector_built;
   NumericVector<Number> * local_old_vector;
   std::unique_ptr<NumericVector<Number>> local_old_vector_built;
   const NumericVector<Number> * old_vector_ptr = nullptr;
 
   if (!active_local_range)
     {
       active_local_range.emplace
         (this->get_mesh().active_local_elements_begin(),
          this->get_mesh().active_local_elements_end());
     }
 
   // If the old vector was uniprocessor, make the new
   // vector uniprocessor
   if (old_v.type() == SERIAL)
     {
       new_v.init (this->n_dofs(), false, SERIAL);
       new_vector_ptr = &new_v;
       old_vector_ptr = &old_v;
     }
 
   // Otherwise it is a parallel, distributed vector, which
   // we need to localize.
   else if (old_v.type() == PARALLEL)
     {
       // Build a send list for efficient localization
       BuildProjectionList projection_list(*this);
       Threads::parallel_reduce (active_local_range.value(),
                                 projection_list);
 
       // Create a sorted, unique send_list
       projection_list.unique();
 
       new_v.init (this->n_dofs(), this->n_local_dofs(), false, PARALLEL);
       new_vector_built = NumericVector<Number>::build(this->comm());
       local_old_vector_built = NumericVector<Number>::build(this->comm());
       new_vector_ptr = new_vector_built.get();
       local_old_vector = local_old_vector_built.get();
       new_vector_ptr->init(this->n_dofs(), this->n_local_dofs(),
                            this->get_dof_map().get_send_list(), false,
                            GHOSTED);
       local_old_vector->init(old_v.size(), old_v.local_size(),
                              projection_list.send_list, false, GHOSTED);
       old_v.localize(*local_old_vector, projection_list.send_list);
       local_old_vector->close();
       old_vector_ptr = local_old_vector;
     }
   else if (old_v.type() == GHOSTED)
     {
       // Build a send list for efficient localization
       BuildProjectionList projection_list(*this);
       Threads::parallel_reduce (active_local_range.value(),
                                 projection_list);
 
       // Create a sorted, unique send_list
       projection_list.unique();
 
       new_v.init (this->n_dofs(), this->n_local_dofs(),
                   this->get_dof_map().get_send_list(), false, GHOSTED);
 
       local_old_vector_built = NumericVector<Number>::build(this->comm());
       new_vector_ptr = &new_v;
       local_old_vector = local_old_vector_built.get();
       local_old_vector->init(old_v.size(), old_v.local_size(),
                              projection_list.send_list, false, GHOSTED);
       old_v.localize(*local_old_vector, projection_list.send_list);
       local_old_vector->close();
       old_vector_ptr = local_old_vector;
     }
   else // unknown old_v.type()
     libmesh_error_msg("ERROR: Unknown old_v.type() == " << old_v.type());
 
   // Note that the above will have zeroed the new_vector.
   // Just to be sure, assert that new_vector_ptr and old_vector_ptr
   // were successfully set before trying to deref them.
   libmesh_assert(new_vector_ptr);
   libmesh_assert(old_vector_ptr);
 
   NumericVector<Number> & new_vector = *new_vector_ptr;
   const NumericVector<Number> & old_vector = *old_vector_ptr;
 
   const unsigned int n_variables = this->n_vars();
 
   if (n_variables)
     {
       std::vector<unsigned int> vars;
       if (variable_numbers)
         {
           vars = *variable_numbers;
           for (auto v : vars)
             if (v >= n_variables)
               libmesh_error_msg("ERROR: variable number " << v <<
                                " out of range for system with " <<
                                n_variables << " variables.");
         }
       else
         {
           vars.resize(n_variables);
           std::iota(vars.begin(), vars.end(), 0);
         }
 
       std::vector<unsigned int> regular_vars, vector_vars;
       for (auto var : vars)
       {
         if (FEInterface::field_type(this->variable_type(var)) == TYPE_SCALAR)
           regular_vars.push_back(var);
         else
           vector_vars.push_back(var);
       }
 
       VectorSetAction<Number> setter(new_vector);
 
       if (!regular_vars.empty())
         {
           // Use a typedef to make the calling sequence for parallel_for() a bit more readable
           typedef
             GenericProjector<OldSolutionValue<Number,   &FEMContext::point_value>,
                              OldSolutionValue<Gradient, &FEMContext::point_gradient>,
                              Number, VectorSetAction<Number>> FEMProjector;
 
           OldSolutionValue<Number,   &FEMContext::point_value>
             f(*this, old_vector, &regular_vars);
           OldSolutionValue<Gradient, &FEMContext::point_gradient>
             g(*this, old_vector, &regular_vars);
 
           FEMProjector projector(*this, f, &g, setter, regular_vars);
           projector.project(active_local_range.value());
         }
 
       if (!vector_vars.empty())
         {
           typedef
             GenericProjector<OldSolutionValue<Gradient,   &FEMContext::point_value>,
                              OldSolutionValue<Tensor, &FEMContext::point_gradient>,
                              Gradient, VectorSetAction<Number>> FEMVectorProjector;
 
           OldSolutionValue<Gradient, &FEMContext::point_value> f_vector(*this, old_vector, &vector_vars);
           OldSolutionValue<Tensor, &FEMContext::point_gradient> g_vector(*this, old_vector, &vector_vars);
 
           FEMVectorProjector vector_projector(*this, f_vector, &g_vector, setter, vector_vars);
           vector_projector.project(active_local_range.value());
         }
 
       // Copy the SCALAR dofs from old_vector to new_vector
       // Note: We assume that all SCALAR dofs are on the
       // processor with highest ID
       if (this->processor_id() == (this->n_processors()-1))
         {
           const DofMap & dof_map = this->get_dof_map();
           for (auto var : vars)
             if (this->variable(var).type().family == SCALAR)
               {
                 // We can just map SCALAR dofs directly across
                 std::vector<dof_id_type> new_SCALAR_indices, old_SCALAR_indices;
                 dof_map.SCALAR_dof_indices (new_SCALAR_indices, var, false);
                 dof_map.SCALAR_dof_indices (old_SCALAR_indices, var, true);
                 for (auto i : index_range(new_SCALAR_indices))
                   new_vector.set(new_SCALAR_indices[i], old_vector(old_SCALAR_indices[i]));
               }
         }
     }
 
   new_vector.close();
 
   // If the old vector was serial, we probably need to send our values
   // to other processors
   //
   // FIXME: I'm not sure how to make a NumericVector do that without
   // creating a temporary parallel vector to use localize! - RHS
   if (old_v.type() == SERIAL)
     {
       std::unique_ptr<NumericVector<Number>> dist_v = NumericVector<Number>::build(this->comm());
       dist_v->init(this->n_dofs(), this->n_local_dofs(), false, PARALLEL);
       dist_v->close();
 
       for (auto i : make_range(dist_v->size()))
         if (new_vector(i) != 0.0)
           dist_v->set(i, new_vector(i));
 
       dist_v->close();
 
       dist_v->localize (new_v, this->get_dof_map().get_send_list());
       new_v.close();
     }
   // If the old vector was parallel, we need to update it
   // and free the localized copies
   else if (old_v.type() == PARALLEL)
     {
       // We may have to set dof values that this processor doesn't
       // own in certain special cases, like LAGRANGE FIRST or
       // HERMITE THIRD elements on second-order meshes?
       new_v = new_vector;
       new_v.close();
     }
 
 
   // Apply constraints only if we we are asked to
   if(this->project_with_constraints)
   {
     if (is_adjoint == -1)
     {
       this->get_dof_map().enforce_constraints_exactly(*this, &new_v);
     }
     else if (is_adjoint >= 0)
     {
       this->get_dof_map().enforce_adjoint_constraints_exactly(new_v,
                                                             is_adjoint);
     }
   }
 #else
 
   // AMR is disabled: simply copy the vector
   new_v = old_v;
 
   libmesh_ignore(is_adjoint, active_local_range, variable_numbers);
 
 #endif // #ifdef LIBMESH_ENABLE_AMR
 }

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

Definition at line 982 of file system_projection.C.

References libMesh::make_range(), n_vars, libMesh::SCALAR, libMesh::DofMap::SCALAR_dof_indices(), and libMesh::SparseMatrix< T >::set().

Referenced by libMesh::PetscDMWrapper::init_petscdm(), SystemsTest::testProjectMatrix1D(), SystemsTest::testProjectMatrix2D(), and SystemsTest::testProjectMatrix3D().

 {
   LOG_SCOPE ("projection_matrix()", "System");
 
   const unsigned int n_variables = this->n_vars();
 
   if (n_variables)
     {
       ConstElemRange active_local_elem_range
         (this->get_mesh().active_local_elements_begin(),
          this->get_mesh().active_local_elements_end());
 
       std::vector<unsigned int> vars(n_variables);
       std::iota(vars.begin(), vars.end(), 0);
 
       // Use a typedef to make the calling sequence for parallel_for() a bit more readable
       typedef OldSolutionCoefs<Real, &FEMContext::point_value> OldSolutionValueCoefs;
       typedef OldSolutionCoefs<RealGradient, &FEMContext::point_gradient> OldSolutionGradientCoefs;
 
       typedef
         GenericProjector<OldSolutionValueCoefs,
                          OldSolutionGradientCoefs,
                          DynamicSparseNumberArray<Real,dof_id_type>,
                          MatrixFillAction<Real, Number> > ProjMatFiller;
 
       OldSolutionValueCoefs    f(*this, &vars);
       OldSolutionGradientCoefs g(*this, &vars);
       MatrixFillAction<Real, Number> setter(proj_mat);
 
       ProjMatFiller mat_filler(*this, f, &g, setter, vars);
       mat_filler.project(active_local_elem_range);
 
       // Set the SCALAR dof transfer entries too.
       // Note: We assume that all SCALAR dofs are on the
       // processor with highest ID
       if (this->processor_id() == (this->n_processors()-1))
         {
           const DofMap & dof_map = this->get_dof_map();
           for (auto var : make_range(this->n_vars()))
             if (this->variable(var).type().family == SCALAR)
               {
                 // We can just map SCALAR dofs directly across
                 std::vector<dof_id_type> new_SCALAR_indices, old_SCALAR_indices;
                 dof_map.SCALAR_dof_indices (new_SCALAR_indices, var, false);
                 dof_map.SCALAR_dof_indices (old_SCALAR_indices, var, true);
                 const unsigned int new_n_dofs =
                   cast_int<unsigned int>(new_SCALAR_indices.size());
 
                 for (unsigned int i=0; i<new_n_dofs; i++)
                   {
                     proj_mat.set( new_SCALAR_indices[i],
                                   old_SCALAR_indices[i], 1);
                   }
               }
         }
     }
 }

◆ prolong_vectors()

void libMesh::System::prolong_vectors ( )

virtualinherited

Prolong vectors after the mesh has refined.

Definition at line 432 of file system.C.

References libMesh::System::restrict_vectors().

Referenced by libMesh::EquationSystems::reinit_solutions().

 {
 #ifdef LIBMESH_ENABLE_AMR
   // Currently project_vector handles both restriction and prolongation
   this->restrict_vectors();
 #endif
 }

◆ qoi_parameter_hessian()

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

inlinevirtualinherited

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

inlinevirtualinherited

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 2629 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ qoi_parameter_sensitivity()

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.

Definition at line 590 of file system.C.

References libMesh::System::adjoint_qoi_parameter_sensitivity(), libMesh::System::forward_qoi_parameter_sensitivity(), libMesh::ParameterVector::size(), and libMesh::QoISet::size().

 {
   // Forward sensitivities are more efficient for Nq > Np
   if (qoi_indices.size(*this) > parameters_vec.size())
     forward_qoi_parameter_sensitivity(qoi_indices, parameters_vec, sensitivities);
   // Adjoint sensitivities are more efficient for Np > Nq,
   // and an adjoint may be more reusable than a forward
   // solution sensitivity in the Np == Nq case.
   else
     adjoint_qoi_parameter_sensitivity(qoi_indices, parameters_vec, sensitivities);
 }

◆ re_update()

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

Definition at line 521 of file system.C.

References libMesh::System::current_local_solution, libMesh::System::get_dof_map(), libMesh::DofMap::get_send_list(), libMesh::System::n_vars(), and libMesh::System::solution.

 {
   parallel_object_only();
 
   // If this system is empty... don't do anything!
   if (!this->n_vars())
     return;
 
   const std::vector<dof_id_type> & send_list = this->get_dof_map().get_send_list ();
 
   // Check sizes
   libmesh_assert_equal_to (current_local_solution->size(), solution->size());
   // Not true with ghosted vectors
   // libmesh_assert_equal_to (current_local_solution->local_size(), solution->size());
   // libmesh_assert (!send_list.empty());
   libmesh_assert_less_equal (send_list.size(), solution->size());
 
   // Create current_local_solution from solution.  This will
   // put a local copy of solution into current_local_solution.
   solution->localize (*current_local_solution, send_list);
 }

◆ read_header()

void libMesh::System::read_header	(	Xdr &	io,
		std::string_view	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.

Definition at line 97 of file system_io.C.

References libMesh::System::_additional_data_written, libMesh::System::_written_var_indices, libMesh::System::add_variable(), libMesh::System::add_vector(), TIMPI::Communicator::broadcast(), libMesh::System::clear(), libMesh::ParallelObject::comm(), libMesh::Utility::contains(), libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_mesh(), libMesh::OrderWrapper::get_order(), libMesh::FEType::inf_map, libMesh::libmesh_assert(), libMesh::MeshBase::mesh_dimension(), libMesh::MONOMIAL, libMesh::on_command_line(), libMesh::FEType::order, libMesh::out, libMesh::ParallelObject::processor_id(), libMesh::FEType::radial_family, libMesh::FEType::radial_order, libMesh::Xdr::reading(), libMesh::System::variable_number(), libMesh::Xdr::version(), and libMesh::XYZ.

Referenced by libMesh::EquationSystems::read(), and libMesh::RBEvaluation::read_in_vectors_from_multiple_files().

 {
   // This method implements the input of a
   // System object, embedded in the output of
   // an EquationSystems<T_sys>.  This warrants some
   // documentation.  The output file essentially
   // consists of 5 sections:
   //
   // for this system
   //
   //   5.) The number of variables in the system (unsigned int)
   //
   //   for each variable in the system
   //
   //     6.) The name of the variable (string)
   //
   //     6.1.) Variable subdomains
   //
   //     7.) Combined in an FEType:
   //         - The approximation order(s) of the variable
   //           (Order Enum, cast to int/s)
   //         - The finite element family/ies of the variable
   //           (FEFamily Enum, cast to int/s)
   //
   //   end variable loop
   //
   //   8.) The number of additional vectors (unsigned int),
   //
   //     for each additional vector in the system object
   //
   //     9.) the name of the additional vector  (string)
   //
   // end system
   libmesh_assert (io.reading());
 
   // Possibly clear data structures and start from scratch.
   if (read_header_in)
     this->clear ();
 
   // Figure out if we need to read infinite element information.
   // This will be true if the version string contains " with infinite elements"
   const bool read_ifem_info =
     Utility::contains(version, " with infinite elements") ||
     libMesh::on_command_line ("--read-ifem-systems");
 
 
   {
     // 5.)
     // Read the number of variables in the system
     unsigned int nv=0;
     if (this->processor_id() == 0)
       io.data (nv);
     this->comm().broadcast(nv);
 
     _written_var_indices.clear();
     _written_var_indices.resize(nv, 0);
 
     for (unsigned int var=0; var<nv; var++)
       {
         // 6.)
         // Read the name of the var-th variable
         std::string var_name;
         if (this->processor_id() == 0)
           io.data (var_name);
         this->comm().broadcast(var_name);
 
         // 6.1.)
         std::set<subdomain_id_type> domains;
         if (io.version() >= LIBMESH_VERSION_ID(0,7,2))
           {
             std::vector<subdomain_id_type> domain_array;
             if (this->processor_id() == 0)
               io.data (domain_array);
             for (const auto & id : domain_array)
               domains.insert(id);
           }
         this->comm().broadcast(domains);
 
         // 7.)
         // Read the approximation order(s) of the var-th variable
         int order=0;
         if (this->processor_id() == 0)
           io.data (order);
         this->comm().broadcast(order);
 
 
         // do the same for infinite element radial_order
         int rad_order=0;
         if (read_ifem_info)
           {
             if (this->processor_id() == 0)
               io.data(rad_order);
             this->comm().broadcast(rad_order);
           }
 
         // Read the finite element type of the var-th variable
         int fam=0;
         if (this->processor_id() == 0)
           io.data (fam);
         this->comm().broadcast(fam);
         FEType type;
         type.order  = static_cast<Order>(order);
         type.family = static_cast<FEFamily>(fam);
 
         // Check for incompatibilities.  The shape function indexing was
         // changed for the monomial and xyz finite element families to
         // simplify extension to arbitrary p.  The consequence is that
         // old restart files will not be read correctly.  This is expected
         // to be an unlikely occurrence, but catch it anyway.
         if (read_legacy_format)
           if ((type.family == MONOMIAL || type.family == XYZ) &&
               ((type.order.get_order() > 2 && this->get_mesh().mesh_dimension() == 2) ||
                (type.order.get_order() > 1 && this->get_mesh().mesh_dimension() == 3)))
             {
               libmesh_here();
               libMesh::out << "*****************************************************************\n"
                            << "* WARNING: reading a potentially incompatible restart file!!!   *\n"
                            << "*  contact libmesh-users@lists.sourceforge.net for more details *\n"
                            << "*****************************************************************"
                            << std::endl;
             }
 
         // Read additional information for infinite elements
         int radial_fam=0;
         int i_map=0;
         if (read_ifem_info)
           {
             if (this->processor_id() == 0)
               io.data (radial_fam);
             this->comm().broadcast(radial_fam);
             if (this->processor_id() == 0)
               io.data (i_map);
             this->comm().broadcast(i_map);
           }
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
 
         type.radial_order  = static_cast<Order>(rad_order);
         type.radial_family = static_cast<FEFamily>(radial_fam);
         type.inf_map       = static_cast<InfMapType>(i_map);
 
 #endif
 
         if (read_header_in)
           {
             if (domains.empty())
               _written_var_indices[var] = this->add_variable (var_name, type);
             else
               _written_var_indices[var] = this->add_variable (var_name, type, &domains);
           }
         else
           _written_var_indices[var] = this->variable_number(var_name);
       }
   }
 
   // 8.)
   // Read the number of additional vectors.
   unsigned int nvecs=0;
   if (this->processor_id() == 0)
     io.data (nvecs);
   this->comm().broadcast(nvecs);
 
   // If nvecs > 0, this means that write_additional_data
   // was true when this file was written.  We will need to
   // make use of this fact later.
   this->_additional_data_written = nvecs;
 
   for (unsigned int vec=0; vec<nvecs; vec++)
     {
       // 9.)
       // Read the name of the vec-th additional vector
       std::string vec_name;
       if (this->processor_id() == 0)
         io.data (vec_name);
       this->comm().broadcast(vec_name);
       if (io.version() >= LIBMESH_VERSION_ID(1,7,0))
         {
           int vec_projection = 0;
           if (this->processor_id() == 0)
             io.data (vec_projection);
           this->comm().broadcast(vec_projection);
           int vec_type;
           if (this->processor_id() == 0)
             io.data (vec_type);
           this->comm().broadcast(vec_type);
 
           if (read_additional_data)
             this->add_vector(vec_name, bool(vec_projection), ParallelType(vec_type));
         }
       else if (read_additional_data)
           // Systems now can handle adding post-initialization vectors
           //  libmesh_assert(this->_can_add_vectors);
           // Some systems may have added their own vectors already
           //  libmesh_assert_equal_to (this->_vectors.count(vec_name), 0);
         this->add_vector(vec_name);
     }
 }

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

This method implements the output of the vectors contained in this System object, embedded in the output of an EquationSystems<T_sys>.

9.) The global solution vector, re-ordered to be node-major (More on this later.)

for each additional vector in the object

10.) The global additional vector, re-ordered to be node-major (More on this later.)

Note that the actual IO is handled through the Xdr class (to be renamed later?) which provides a uniform interface to both the XDR (eXternal Data Representation) interface and standard ASCII output. Thus this one section of code will read XDR or ASCII files with no changes.

Definition at line 302 of file system_io.C.

References libMesh::System::_additional_data_written, libMesh::System::_vectors, libMesh::System::_written_var_indices, libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::DofObject::invalid_id, libMesh::Xdr::is_open(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::ParallelObject::n_processors(), libMesh::System::n_vars(), libMesh::System::number(), libMesh::ParallelObject::processor_id(), libMesh::Xdr::reading(), libMesh::SCALAR, libMesh::DofMap::SCALAR_dof_indices(), libMesh::System::solution, libMesh::Variable::type(), and libMesh::System::variable().

 {
   // PerfLog pl("IO Performance",false);
   // pl.push("read_parallel_data");
   [[maybe_unused]] dof_id_type total_read_size = 0;
 
   libmesh_assert (io.reading());
   libmesh_assert (io.is_open());
 
   // build the ordered nodes and element maps.
   // when writing/reading parallel files we need to iterate
   // over our nodes/elements in order of increasing global id().
   // however, this is not guaranteed to be ordering we obtain
   // by using the node_iterators/element_iterators directly.
   // so build a set, sorted by id(), that provides the ordering.
   // further, for memory economy build the set but then transfer
   // its contents to vectors, which will be sorted.
   std::vector<const DofObject *> ordered_nodes, ordered_elements;
   {
     std::set<const DofObject *, CompareDofObjectsByID>
       ordered_nodes_set (this->get_mesh().local_nodes_begin(),
                          this->get_mesh().local_nodes_end());
 
     ordered_nodes.insert(ordered_nodes.end(),
                          ordered_nodes_set.begin(),
                          ordered_nodes_set.end());
   }
   {
     std::set<const DofObject *, CompareDofObjectsByID>
       ordered_elements_set (this->get_mesh().local_elements_begin(),
                             this->get_mesh().local_elements_end());
 
     ordered_elements.insert(ordered_elements.end(),
                             ordered_elements_set.begin(),
                             ordered_elements_set.end());
   }
 
   //  std::vector<Number> io_buffer;
   std::vector<InValType> io_buffer;
 
   // 9.)
   //
   // Actually read the solution components
   // for the ith system to disk
   io.data(io_buffer);
 
   total_read_size += cast_int<dof_id_type>(io_buffer.size());
 
   const unsigned int sys_num = this->number();
   const unsigned int nv      = cast_int<unsigned int>
     (this->_written_var_indices.size());
   libmesh_assert_less_equal (nv, this->n_vars());
 
   dof_id_type cnt=0;
 
   // Loop over each non-SCALAR variable and each node, and read out the value.
   for (unsigned int data_var=0; data_var<nv; data_var++)
     {
       const unsigned int var = _written_var_indices[data_var];
       if (this->variable(var).type().family != SCALAR)
         {
           // First read the node DOF values
           for (const auto & node : ordered_nodes)
             for (auto comp : make_range(node->n_comp(sys_num,var)))
               {
                 libmesh_assert_not_equal_to (node->dof_number(sys_num, var, comp),
                                              DofObject::invalid_id);
                 libmesh_assert_less (cnt, io_buffer.size());
                 this->solution->set(node->dof_number(sys_num, var, comp), io_buffer[cnt++]);
               }
 
           // Then read the element DOF values
           for (const auto & elem : ordered_elements)
             for (auto comp : make_range(elem->n_comp(sys_num,var)))
               {
                 libmesh_assert_not_equal_to (elem->dof_number(sys_num, var, comp),
                                              DofObject::invalid_id);
                 libmesh_assert_less (cnt, io_buffer.size());
                 this->solution->set(elem->dof_number(sys_num, var, comp), io_buffer[cnt++]);
               }
         }
     }
 
   // Finally, read the SCALAR variables on the last processor
   for (unsigned int data_var=0; data_var<nv; data_var++)
     {
       const unsigned int var = _written_var_indices[data_var];
       if (this->variable(var).type().family == SCALAR)
         {
           if (this->processor_id() == (this->n_processors()-1))
             {
               const DofMap & dof_map = this->get_dof_map();
               std::vector<dof_id_type> SCALAR_dofs;
               dof_map.SCALAR_dof_indices(SCALAR_dofs, var);
 
               for (auto dof : SCALAR_dofs)
                 this->solution->set(dof, io_buffer[cnt++]);
             }
         }
     }
 
   // And we're done setting solution entries
   this->solution->close();
 
   // For each additional vector, simply go through the list.
   // ONLY attempt to do this IF additional data was actually
   // written to the file for this system (controlled by the
   // _additional_data_written flag).
   if (this->_additional_data_written)
     {
       const std::size_t nvecs = this->_vectors.size();
 
       // If the number of additional vectors written is non-zero, and
       // the number of additional vectors we have is non-zero, and
       // they don't match, then something is wrong and we can't be
       // sure we're reading data into the correct places.
       if (read_additional_data && nvecs &&
           nvecs != this->_additional_data_written)
         libmesh_error_msg
           ("Additional vectors in file do not match system");
 
       auto pos = _vectors.begin();
 
       for (std::size_t i = 0; i != this->_additional_data_written; ++i)
         {
           cnt=0;
           io_buffer.clear();
 
           // 10.)
           //
           // Actually read the additional vector components
           // for the ith system from disk
           io.data(io_buffer);
 
           total_read_size += cast_int<dof_id_type>(io_buffer.size());
 
           // If read_additional_data==true and we have additional vectors,
           // then we will keep this vector data; otherwise we are going to
           // throw it away.
           if (read_additional_data && nvecs)
             {
               // Loop over each non-SCALAR variable and each node, and read out the value.
               for (unsigned int data_var=0; data_var<nv; data_var++)
                 {
                   const unsigned int var = _written_var_indices[data_var];
                   if (this->variable(var).type().family != SCALAR)
                     {
                       // First read the node DOF values
                       for (const auto & node : ordered_nodes)
                         for (auto comp : make_range(node->n_comp(sys_num,var)))
                           {
                             libmesh_assert_not_equal_to (node->dof_number(sys_num, var, comp),
                                                          DofObject::invalid_id);
                             libmesh_assert_less (cnt, io_buffer.size());
                             pos->second->set(node->dof_number(sys_num, var, comp), io_buffer[cnt++]);
                           }
 
                       // Then read the element DOF values
                       for (const auto & elem : ordered_elements)
                         for (auto comp : make_range(elem->n_comp(sys_num,var)))
                           {
                             libmesh_assert_not_equal_to (elem->dof_number(sys_num, var, comp),
                                                          DofObject::invalid_id);
                             libmesh_assert_less (cnt, io_buffer.size());
                             pos->second->set(elem->dof_number(sys_num, var, comp), io_buffer[cnt++]);
                           }
                     }
                 }
 
               // Finally, read the SCALAR variables on the last processor
               for (unsigned int data_var=0; data_var<nv; data_var++)
                 {
                   const unsigned int var = _written_var_indices[data_var];
                   if (this->variable(var).type().family == SCALAR)
                     {
                       if (this->processor_id() == (this->n_processors()-1))
                         {
                           const DofMap & dof_map = this->get_dof_map();
                           std::vector<dof_id_type> SCALAR_dofs;
                           dof_map.SCALAR_dof_indices(SCALAR_dofs, var);
 
                           for (auto dof : SCALAR_dofs)
                             pos->second->set(dof, io_buffer[cnt++]);
                         }
                     }
                 }
 
               // And we're done setting entries for this variable
               pos->second->close();
             }
 
           // If we've got vectors then we need to be iterating through
           // those too
           if (pos != this->_vectors.end())
             ++pos;
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_read_size*sizeof(Number)/dt;
 
   // libMesh::err << "Read " << total_read_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("read_parallel_data");
 }

◆ read_parallel_data() [2/2]

template LIBMESH_EXPORT void libMesh::System::read_parallel_data< Real >	(	Xdr &	io,
		const bool	read_additional_data
	)

inlineinherited

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 1412 of file system.h.

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

Definition at line 262 of file rb_parametrized.C.

References libMesh::RBParametrized::initialize_parameters(), libMesh::RBParametrized::read_discrete_parameter_values_from_file(), and libMesh::RBParametrized::read_parameter_ranges_from_file().

Referenced by libMesh::RBSCMEvaluation::legacy_read_offline_data_from_files(), and libMesh::RBEvaluation::legacy_read_offline_data_from_files().

 {
   RBParameters param_min;
   RBParameters param_max;
   read_parameter_ranges_from_file(continuous_param_file_name,
                                   read_binary_data,
                                   param_min,
                                   param_max);
 
   std::map<std::string, std::vector<Real>> discrete_parameter_values_in;
   read_discrete_parameter_values_from_file(discrete_param_file_name,
                                            read_binary_data,
                                            discrete_parameter_values_in);
 
   initialize_parameters(param_min, param_max, discrete_parameter_values_in);
 }

◆ read_serialized_data() [1/2]

template<typename InValType >

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.

Definition at line 533 of file system_io.C.

References libMesh::System::_additional_data_written, libMesh::System::_vectors, libMesh::ParallelObject::processor_id(), and libMesh::System::solution.

Referenced by libMesh::TransientRBConstruction::initialize_truth(), libMesh::TransientRBConstruction::read_riesz_representors_from_files(), and libMesh::RBConstruction::read_riesz_representors_from_files().

 {
   // This method implements the input of the vectors
   // contained in this System object, embedded in the
   // output of an EquationSystems<T_sys>.
   //
   //   10.) The global solution vector, re-ordered to be node-major
   //       (More on this later.)
   //
   //      for each additional vector in the object
   //
   //      11.) The global additional vector, re-ordered to be
   //          node-major (More on this later.)
   parallel_object_only();
   std::string comment;
 
   // PerfLog pl("IO Performance",false);
   // pl.push("read_serialized_data");
   // std::size_t total_read_size = 0;
 
   // 10.)
   // Read the global solution vector
   {
     // total_read_size +=
     this->read_serialized_vector<InValType>(io, this->solution.get());
 
     // get the comment
     if (this->processor_id() == 0)
       io.comment (comment);
   }
 
   // 11.)
   // Only read additional vectors if data is available, and only use
   // that data to fill our vectors if the user requested it.
   if (this->_additional_data_written)
     {
       const std::size_t nvecs = this->_vectors.size();
 
       // If the number of additional vectors written is non-zero, and
       // the number of additional vectors we have is non-zero, and
       // they don't match, then we can't read additional vectors
       // and be sure we're reading data into the correct places.
       if (read_additional_data && nvecs &&
           nvecs != this->_additional_data_written)
         libmesh_error_msg
           ("Additional vectors in file do not match system");
 
       auto pos = _vectors.begin();
 
       for (std::size_t i = 0; i != this->_additional_data_written; ++i)
         {
           // Read data, but only put it into a vector if we've been
           // asked to and if we have a corresponding vector to read.
 
           // total_read_size +=
           this->read_serialized_vector<InValType>
             (io, (read_additional_data && nvecs) ? pos->second.get() : nullptr);
 
           // get the comment
           if (this->processor_id() == 0)
             io.comment (comment);
 
 
           // If we've got vectors then we need to be iterating through
           // those too
           if (pos != this->_vectors.end())
             ++pos;
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_read_size*sizeof(Number)/dt;
 
   // libMesh::out << "Read " << total_read_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("read_serialized_data");
 }

◆ read_serialized_data() [2/2]

template LIBMESH_EXPORT void libMesh::System::read_serialized_data< Real >	(	Xdr &	io,
		const bool	read_additional_data = `true`
	)

inlineinherited

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 1370 of file system.h.

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

Definition at line 2018 of file system_io.C.

References libMesh::Xdr::data(), libMesh::System::get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshTools::n_elem(), libMesh::MeshBase::n_elem(), n_nodes, libMesh::MeshBase::n_nodes(), libMesh::System::n_vars(), libMesh::ParallelObject::processor_id(), libMesh::System::read_SCALAR_dofs(), libMesh::System::read_serialized_blocked_dof_objects(), libMesh::Xdr::reading(), libMesh::SCALAR, and libMesh::System::variable().

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

 {
   parallel_object_only();
 
   // Error checking
   // #ifndef NDEBUG
   //   // In parallel we better be reading a parallel vector -- if not
   //   // we will not set all of its components below!!
   //   if (this->n_processors() > 1)
   //     {
   //       libmesh_assert (vec.type() == PARALLEL ||
   //       vec.type() == GHOSTED);
   //     }
   // #endif
 
   libmesh_assert (io.reading());
 
   if (this->processor_id() == 0)
     {
       // sizes
       unsigned int num_vecs=0;
       dof_id_type vector_length=0;
 
       // Get the number of vectors
       io.data(num_vecs);
       // Get the buffer size
       io.data(vector_length);
 
       libmesh_error_msg_if
         (num_vecs != vectors.size(),
          "Xdr file header declares " << num_vecs << " vectors, but we were asked to read " << vectors.size());
 
       if (num_vecs != 0)
         {
           libmesh_error_msg_if (vectors[0] == nullptr, "vectors[0] should not be null");
           libmesh_error_msg_if (vectors[0]->size() != vector_length, "Inconsistent vector sizes");
         }
     }
 
   // no need to actually communicate these.
   // this->comm().broadcast(num_vecs);
   // this->comm().broadcast(vector_length);
 
   // Cache these - they are not free!
   const dof_id_type
     n_nodes = this->get_mesh().n_nodes(),
     n_elem  = this->get_mesh().n_elem();
 
   std::size_t read_length = 0;
 
   //---------------------------------
   // Collect the values for all nodes
   read_length +=
     this->read_serialized_blocked_dof_objects (n_nodes,
                                                this->get_mesh().local_nodes_begin(),
                                                this->get_mesh().local_nodes_end(),
                                                InValType(),
                                                io,
                                                vectors);
 
   //------------------------------------
   // Collect the values for all elements
   read_length +=
     this->read_serialized_blocked_dof_objects (n_elem,
                                                this->get_mesh().local_elements_begin(),
                                                this->get_mesh().local_elements_end(),
                                                InValType(),
                                                io,
                                                vectors);
 
   //-------------------------------------------
   // Finally loop over all the SCALAR variables
   for (NumericVector<Number> * vec : vectors)
     for (auto var : make_range(this->n_vars()))
       if (this->variable(var).type().family == SCALAR)
         {
           libmesh_assert_not_equal_to (vec, 0);
 
           read_length +=
             this->read_SCALAR_dofs (var, io, vec);
         }
 
   //---------------------------------------
   // last step - must close all the vectors
   for (NumericVector<Number> * vec : vectors)
     {
       libmesh_assert_not_equal_to (vec, 0);
       vec->close();
     }
 
   return read_length;
 }

◆ read_serialized_vectors() [2/2]

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

inlineinherited

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 1390 of file system.h.

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

◆ reinit()

void libMesh::System::reinit ( )

virtualinherited

Reinitializes degrees of freedom and other required data on the current mesh.

Note: The matrix is not initialized at this time since it may not be required for all applications. Should be overridden in derived classes.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::CondensedEigenSystem, libMesh::LinearImplicitSystem, libMesh::EigenSystem, libMesh::DifferentiableSystem, and libMesh::NewmarkSystem.

Definition at line 442 of file system.C.

References libMesh::System::_basic_system_only, libMesh::System::_matrices, libMesh::System::_require_sparsity_pattern, libMesh::DofMap::clear_sparsity(), libMesh::DofMap::compute_sparsity(), libMesh::System::current_local_solution, libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::DofMap::reinit_static_condensation(), and libMesh::System::solution.

Referenced by alternative_fe_assembly(), libMesh::RBEIMConstruction::initialize_qp_data(), libMesh::DifferentiableSystem::reinit(), libMesh::EigenSystem::reinit(), libMesh::LinearImplicitSystem::reinit(), libMesh::OptimizationSystem::reinit(), and libMesh::NonlinearImplicitSystem::reinit().

 {
   parallel_object_only();
 
   // project_vector handles vector initialization now
   libmesh_assert_equal_to (solution->size(), current_local_solution->size());
 
   // Make sure our static condensation dof map is up-to-date before we init any
   // static condensation matrices
   this->get_dof_map().reinit_static_condensation();
 
   if (!_matrices.empty() && !_basic_system_only)
     {
       // Clear the matrices
       for (auto & pr : _matrices)
         {
           pr.second->clear();
           pr.second->attach_dof_map(this->get_dof_map());
         }
 
       if (this->_require_sparsity_pattern)
         {
           // Clear the sparsity pattern
           this->get_dof_map().clear_sparsity();
 
           // Compute the sparsity pattern for the current
           // mesh and DOF distribution.  This also updates
           // additional matrices, \p DofMap now knows them
           this->get_dof_map().compute_sparsity (this->get_mesh());
         }
 
       // Initialize matrices and set to zero
       for (auto & pr : _matrices)
         {
           pr.second->init();
           pr.second->zero();
         }
     }
 }

◆ reinit_constraints()

void libMesh::System::reinit_constraints ( )

virtualinherited

Reinitializes the constraints for this system.

Also prepares the send_list, whether or not constraints have changed.

Definition at line 483 of file system.C.

References libMesh::System::_mesh, libMesh::DofMap::create_dof_constraints(), libMesh::System::get_dof_map(), libMesh::on_command_line(), libMesh::out, libMesh::DofMap::prepare_send_list(), libMesh::DofMap::print_dof_constraints(), libMesh::DofMap::process_constraints(), libMesh::System::time, and libMesh::System::user_constrain().

Referenced by libMesh::EquationSystems::allgather(), libMesh::System::init_data(), libMesh::PetscDMWrapper::init_petscdm(), and libMesh::EquationSystems::reinit_solutions().

 {
   parallel_object_only();
 
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
   get_dof_map().create_dof_constraints(_mesh, this->time);
   user_constrain();
   get_dof_map().process_constraints(_mesh);
   if (libMesh::on_command_line ("--print-constraints"))
     get_dof_map().print_dof_constraints(libMesh::out);
 #endif
   get_dof_map().prepare_send_list();
 }

◆ reinit_eim_projection_matrix()

void libMesh::RBEIMConstruction::reinit_eim_projection_matrix ( )

inherited

Zero the _eim_projection_matrix and resize it to be get_Nmax() x get_Nmax().

Definition at line 1361 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_eim_projection_matrix, libMesh::RBEIMConstruction::get_Nmax(), libMesh::RBEIMConstruction::get_rb_eim_evaluation(), libMesh::DenseMatrix< T >::resize(), and libMesh::RBEIMEvaluation::use_eim_error_indicator().

 {
   RBEIMEvaluation & rbe = get_rb_eim_evaluation();
 
   // We need space for one extra interpolation point if we're using the
   // EIM error indicator.
   unsigned int max_matrix_size = rbe.use_eim_error_indicator() ? get_Nmax()+1 : get_Nmax();
   _eim_projection_matrix.resize(max_matrix_size,max_matrix_size);
 }

◆ reinit_mesh()

void libMesh::System::reinit_mesh ( )

virtualinherited

Reinitializes the system with a new mesh.

Definition at line 289 of file system.C.

References libMesh::System::_basic_system_only, libMesh::System::init_data(), libMesh::System::n_vars(), and libMesh::System::user_initialization().

Referenced by libMesh::System::init(), libMesh::PetscPreconditioner< T >::set_hypre_ads_data(), and libMesh::PetscPreconditioner< T >::set_hypre_ams_data().

 {
   parallel_object_only();
 
   // First initialize any required data:
   // either only the basic System data
   if (_basic_system_only)
     System::init_data();
   // or all the derived class' data too
   else
     this->init_data();
 
   // If no variables have been added to this system
   // don't do anything
   if (!this->n_vars())
     return;
 
   // Then call the user-provided initialization function
   this->user_initialization();
 
 }

◆ remove_matrix()

void libMesh::System::remove_matrix ( std::string_view mat_name )

inherited

Removes the additional matrix mat_name from this system.

Definition at line 1076 of file system.C.

References libMesh::System::_matrices.

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   if (const auto pos = _matrices.find(mat_name);
       pos != _matrices.end())
     _matrices.erase(pos); // erase()'d entries are destroyed
 }

◆ remove_vector()

void libMesh::System::remove_vector ( std::string_view vec_name )

inherited

Removes the additional vector vec_name from this system.

Definition at line 861 of file system.C.

References libMesh::System::_vector_is_adjoint, libMesh::System::_vector_projections, libMesh::System::_vectors, and libMesh::libmesh_assert().

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and libMesh::UnsteadySolver::integrate_adjoint_sensitivity().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   if (const auto pos = _vectors.find(vec_name);
       pos != _vectors.end())
     {
       _vectors.erase(pos);
       auto proj_it = _vector_projections.find(vec_name);
       libmesh_assert(proj_it != _vector_projections.end());
       _vector_projections.erase(proj_it);
 
       auto adj_it = _vector_is_adjoint.find(vec_name);
       libmesh_assert(adj_it != _vector_is_adjoint.end());
       _vector_is_adjoint.erase(adj_it);
     }
 }

◆ request_matrix() [1/2]

const SparseMatrix< Number > * libMesh::System::request_matrix ( std::string_view mat_name ) const

inherited

Returns: A const pointer to this system's additional matrix named mat_name, or nullptr if no matrix by that name exists.

Definition at line 1087 of file system.C.

References libMesh::System::_matrices.

Referenced by libMesh::EigenSystem::has_matrix_A(), libMesh::EigenSystem::has_matrix_B(), libMesh::EigenSystem::has_precond_matrix(), libMesh::ImplicitSystem::sensitivity_solve(), libMesh::NewtonSolver::solve(), and libMesh::LinearImplicitSystem::solve().

 {
   if (const auto pos = _matrices.find(mat_name);
       pos != _matrices.end())
     return pos->second.get();
 
   // Otherwise, mat_name does not exist
   return nullptr;
 }

◆ request_matrix() [2/2]

SparseMatrix< Number > * libMesh::System::request_matrix ( std::string_view mat_name )

inherited

Returns: A writable pointer to this system's additional matrix named mat_name, or nullptr if no matrix by that name exists.

Definition at line 1099 of file system.C.

References libMesh::System::_matrices.

 {
   if (auto pos = _matrices.find(mat_name);
       pos != _matrices.end())
     return pos->second.get();
 
   // Otherwise, mat_name does not exist
   return nullptr;
 }

◆ request_vector() [1/4]

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

inherited

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

Definition at line 879 of file system.C.

References libMesh::System::_vectors, and libMesh::NumericVector< T >::get().

Referenced by libMesh::UniformRefinementEstimator::_estimate_error().

 {
   if (const auto pos = _vectors.find(vec_name);
       pos != _vectors.end())
     return pos->second.get();
 
   // Otherwise, vec_name was not found
   return nullptr;
 }

◆ request_vector() [2/4]

NumericVector< Number > * libMesh::System::request_vector ( std::string_view vec_name )

inherited

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

Definition at line 891 of file system.C.

References libMesh::System::_vectors, and libMesh::NumericVector< T >::get().

 {
   if (auto pos = _vectors.find(vec_name);
       pos != _vectors.end())
     return pos->second.get();
 
   // Otherwise, vec_name was not found
   return nullptr;
 }

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

Definition at line 903 of file system.C.

References libMesh::System::_vectors, and libMesh::System::vectors_begin().

 {
   // If we don't have that many vectors, return nullptr
   if (vec_num >= _vectors.size())
     return nullptr;
 
   // Otherwise return a pointer to the vec_num'th vector
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return it->second.get();
 }

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

Definition at line 917 of file system.C.

References libMesh::System::_vectors, and libMesh::System::vectors_begin().

 {
   // If we don't have that many vectors, return nullptr
   if (vec_num >= _vectors.size())
     return nullptr;
 
   // Otherwise return a pointer to the vec_num'th vector
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return it->second.get();
 }

◆ restrict_solve_to()

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.

Definition at line 545 of file system.C.

 {
   if (subset != nullptr)
     libmesh_not_implemented();
 }

◆ restrict_vectors()

void libMesh::System::restrict_vectors ( )

virtualinherited

Restrict vectors after the mesh has coarsened.

Definition at line 374 of file system.C.

References libMesh::System::_dof_map, libMesh::System::_solution_projection, libMesh::System::_vector_projections, libMesh::System::_vectors, libMesh::System::current_local_solution, libMesh::NumericVector< T >::get(), libMesh::GHOSTED, libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), libMesh::PARALLEL, libMesh::System::project_vector(), libMesh::System::solution, and libMesh::System::vector_is_adjoint().

Referenced by libMesh::System::prolong_vectors(), and libMesh::EquationSystems::reinit_solutions().

 {
   parallel_object_only();
 
 #ifdef LIBMESH_ENABLE_AMR
   // Restrict the _vectors on the coarsened cells
   for (auto & [vec_name, vec] : _vectors)
     {
       NumericVector<Number> * v = vec.get();
 
       if (_vector_projections[vec_name])
         {
           this->project_vector (*v, this->vector_is_adjoint(vec_name));
         }
       else
         {
           const ParallelType type = vec->type();
 
           if (type == GHOSTED)
             {
 #ifdef LIBMESH_ENABLE_GHOSTED
               vec->init (this->n_dofs(), this->n_local_dofs(),
                                _dof_map->get_send_list(), /*fast=*/false,
                                GHOSTED);
 #else
               libmesh_error_msg("Cannot initialize ghosted vectors when they are not enabled.");
 #endif
             }
           else
             vec->init (this->n_dofs(), this->n_local_dofs(), false, type);
         }
     }
 
   const std::vector<dof_id_type> & send_list = _dof_map->get_send_list ();
 
   // Restrict the solution on the coarsened cells
   if (_solution_projection)
     this->project_vector (*solution);
   // Or at least make sure the solution vector is the correct size
   else
     solution->init (this->n_dofs(), this->n_local_dofs(), true, PARALLEL);
 
 #ifdef LIBMESH_ENABLE_GHOSTED
   current_local_solution->init(this->n_dofs(),
                                this->n_local_dofs(), send_list,
                                false, GHOSTED);
 #else
   current_local_solution->init(this->n_dofs());
 #endif
 
   if (_solution_projection)
     solution->localize (*current_local_solution, send_list);
 
 #endif // LIBMESH_ENABLE_AMR
 }

◆ sensitivity_solve()

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

inlinevirtualinherited

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 2571 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ set_abs_training_tolerance()

void libMesh::RBEIMConstruction::set_abs_training_tolerance ( Real new_training_tolerance )

inherited

Get/set the absolute tolerance for the basis training.

Definition at line 1200 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_abs_training_tolerance.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   _abs_training_tolerance = new_training_tolerance;
 }

◆ set_adjoint_already_solved()

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

inlineinherited

Setter for the adjoint_already_solved boolean.

Definition at line 417 of file system.h.

References libMesh::System::adjoint_already_solved.

Referenced by main().

418 { 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:2332

◆ set_basic_system_only()

void libMesh::System::set_basic_system_only ( )

inlineinherited

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 2465 of file system.h.

References libMesh::System::_basic_system_only.

Referenced by libMesh::EquationSystems::read().

 {
   _basic_system_only = true;
 }

◆ set_best_fit_type_flag()

void libMesh::RBEIMConstruction::set_best_fit_type_flag ( const std::string & best_fit_type_string )

virtualinherited

Specify which type of "best fit" we use to guide the EIM greedy algorithm.

Definition at line 169 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::best_fit_type_flag, libMesh::RBEIMConstruction::EIM_BEST_FIT, libMesh::RBEIMConstruction::POD_BEST_FIT, and libMesh::RBEIMConstruction::PROJECTION_BEST_FIT.

Referenced by libMesh::RBEIMConstruction::process_parameters_file().

 {
   if (best_fit_type_string == "projection")
     {
       best_fit_type_flag = PROJECTION_BEST_FIT;
     }
   else if (best_fit_type_string == "eim")
     {
       best_fit_type_flag = EIM_BEST_FIT;
     }
   else if (best_fit_type_string == "pod")
     {
       best_fit_type_flag = POD_BEST_FIT;
     }
   else
     libmesh_error_msg("Error: invalid best_fit_type in input file");
 }

◆ set_deterministic_training_parameter_name()

void libMesh::RBConstructionBase< System >::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_Nmax()

void libMesh::RBEIMConstruction::set_Nmax ( unsigned int Nmax )

virtualinherited

Definition at line 1215 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_Nmax.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   _Nmax = Nmax;
 }

◆ set_normalize_solution_snapshots()

void libMesh::RBConstructionBase< System >::set_normalize_solution_snapshots ( bool value )

inherited

Set the boolean option that indicates if we normalization solution snapshots or not.

Definition at line 147 of file rb_construction_base.C.

 {
   _normalize_solution_snapshots = value;
 }

◆ set_parameters()

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

inherited

Set the current parameters to params The parameters are checked for validity; an error is thrown if the number of parameters or samples is different than expected.

We

Returns: a boolean true if the new parameters are within the min/max range, and false otherwise (but the parameters are set regardless). Enabling the "verbose_mode" flag will also print more details.

Definition at line 129 of file rb_parametrized.C.

References libMesh::RBParametrized::check_if_valid_params(), libMesh::RBParametrized::parameters, and libMesh::RBParametrized::parameters_initialized.

Referenced by libMesh::RBSCMConstruction::compute_SCM_bounds_on_training_set(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_interiors(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_nodes(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_sides(), libMesh::RBConstruction::get_RB_error_bound(), SimpleRBEvaluation::get_stability_lower_bound(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBSCMEvaluation::reload_current_parameters(), libMesh::RBSCMEvaluation::set_current_parameters_from_C_J(), and RBParametersTest::testRBParametrized().

 {
   libmesh_error_msg_if(!parameters_initialized, "Error: parameters not initialized in RBParametrized::set_parameters");
 
   // Terminate if params has the wrong number of parameters or samples.
   // If the parameters are outside the min/max range, return false.
   const bool valid_params = check_if_valid_params(params);
 
   // Make a copy of params (default assignment operator just does memberwise copy, which is sufficient here)
   this->parameters = params;
 
   return valid_params;
 }

◆ set_params_from_training_set()

void libMesh::RBConstructionBase< System >::set_params_from_training_set ( unsigned int global_index )

protectedinherited

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

Definition at line 225 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::enrich_eim_approximation(), libMesh::RBEIMConstruction::initialize_parametrized_functions_in_training_set(), and libMesh::RBEIMConstruction::train_eim_approximation_with_greedy().

 {
   set_parameters(get_params_from_training_set(global_index));
 }

◆ set_params_from_training_set_and_broadcast()

void libMesh::RBConstructionBase< System >::set_params_from_training_set_and_broadcast ( unsigned int global_index )

protectedvirtualinherited

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

Definition at line 270 of file rb_construction_base.C.

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
                        "Error: training parameters must first be initialized.");
 
   processor_id_type root_id = 0;
   if ((this->get_first_local_training_index() <= global_index) &&
       (global_index < this->get_last_local_training_index()))
     {
       // Set parameters on only one processor
       set_params_from_training_set(global_index);
 
       // set root_id, only non-zero on one processor
       root_id = this->processor_id();
     }
 
   // broadcast
   this->comm().max(root_id);
   broadcast_parameters(root_id);
 }

◆ set_project_with_constraints()

void libMesh::System::set_project_with_constraints ( bool _project_with_constraints )

inlineinherited

Definition at line 1842 of file system.h.

References libMesh::System::project_with_constraints.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error().

   {
     project_with_constraints = _project_with_constraints;
   }

◆ set_qoi() [1/2]

void libMesh::System::set_qoi	(	unsigned int	qoi_index,
		Number	qoi_value
	)

inherited

Definition at line 2176 of file system.C.

References libMesh::System::_qoi, and libMesh::libmesh_assert().

Referenced by libMesh::ExplicitSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), and libMesh::EulerSolver::integrate_qoi_timestep().

 {
   libmesh_assert(qoi_index < _qoi.size());
 
   _qoi[qoi_index] = qoi_value;
 }

◆ set_qoi() [2/2]

void libMesh::System::set_qoi ( std::vector< Number > new_qoi )

inherited

Definition at line 2197 of file system.C.

References libMesh::System::_qoi.

 {
   libmesh_assert_equal_to(this->_qoi.size(), new_qoi.size());
   this->_qoi = std::move(new_qoi);
 }

◆ set_qoi_error_estimate()

void libMesh::System::set_qoi_error_estimate	(	unsigned int	qoi_index,
		Number	qoi_error_estimate
	)

inherited

Definition at line 2204 of file system.C.

References libMesh::System::_qoi_error_estimates, and libMesh::libmesh_assert().

Referenced by libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), and libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate().

 {
   libmesh_assert(qoi_index < _qoi_error_estimates.size());
 
   _qoi_error_estimates[qoi_index] = qoi_error_estimate;
 }

◆ set_quiet_mode()

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

inlineinherited

Set the quiet_mode flag.

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

Definition at line 100 of file rb_construction_base.h.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

101 { this->quiet_mode = quiet_mode_in; }

libMesh::RBConstructionBase< System >::quiet_mode

bool quiet_mode

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

Definition: rb_construction_base.h:265

◆ set_rb_construction_parameters()

void libMesh::RBEIMConstruction::set_rb_construction_parameters	(	unsigned int	n_training_samples_in,
		bool	deterministic_training_in,
		int	training_parameters_random_seed_in,
		bool	quiet_mode_in,
		unsigned int	Nmax_in,
		Real	rel_training_tolerance_in,
		Real	abs_training_tolerance_in,
		const RBParameters &	mu_min_in,
		const RBParameters &	mu_max_in,
		const std::map< std::string, std::vector< Real >> &	discrete_parameter_values_in,
		const std::map< std::string, bool > &	log_scaling,
		std::map< std::string, std::vector< RBParameter >> *	training_sample_list = `nullptr`
	)

inherited

Set the state of this RBConstruction object based on the arguments to this function.

Definition at line 308 of file rb_eim_construction.C.

References libMesh::RBParametrized::get_parameters_max(), libMesh::RBParametrized::get_parameters_min(), libMesh::RBEIMEvaluation::get_parametrized_function(), libMesh::RBEIMConstruction::get_rb_eim_evaluation(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBConstructionBase< System >::initialize_training_parameters(), libMesh::RBConstructionBase< System >::load_training_set(), libMesh::RBParametrizedFunction::lookup_table_param_name, libMesh::Real, libMesh::RBEIMConstruction::set_abs_training_tolerance(), libMesh::RBEIMConstruction::set_Nmax(), libMesh::RBConstructionBase< System >::set_quiet_mode(), libMesh::RBEIMConstruction::set_rel_training_tolerance(), libMesh::RBConstructionBase< System >::set_training_parameter_values(), and libMesh::RBConstructionBase< System >::set_training_random_seed().

Referenced by libMesh::RBEIMConstruction::process_parameters_file().

 {
   // Read in training_parameters_random_seed value.  This is used to
   // seed the RNG when picking the training parameters.  By default the
   // value is -1, which means use std::time to seed the RNG.
   set_training_random_seed(training_parameters_random_seed_in);
 
   // Set quiet mode
   set_quiet_mode(quiet_mode_in);
 
   // Initialize RB parameters
   set_Nmax(Nmax_in);
 
   set_rel_training_tolerance(rel_training_tolerance_in);
   set_abs_training_tolerance(abs_training_tolerance_in);
 
   if (get_rb_eim_evaluation().get_parametrized_function().is_lookup_table)
     {
       const std::string & lookup_table_param_name =
         get_rb_eim_evaluation().get_parametrized_function().lookup_table_param_name;
 
       libmesh_error_msg_if(!discrete_parameter_values_in.count(lookup_table_param_name),
         "Lookup table parameter should be discrete");
 
       // Make an editable copy of discrete_parameters_values_in.
       std::map<std::string, std::vector<Real>> discrete_parameter_values_final(
           discrete_parameter_values_in);
 
       std::vector<Real> & lookup_table_param_values =
         libmesh_map_find(discrete_parameter_values_final, lookup_table_param_name);
 
       // Overwrite the discrete values for lookup_table_param to make sure that
       // it is: 0, 1, 2, ..., size-1.
       std::iota(lookup_table_param_values.begin(), lookup_table_param_values.end(), 0);
 
       // Also, overwrite n_training_samples_in to make sure it matches
       // lookup_table_size so that we will get full coverage of the
       // lookup table in our training set.
       n_training_samples_in = lookup_table_param_values.size();
 
       // Initialize the parameter ranges and the parameters themselves
       initialize_parameters(mu_min_in, mu_max_in, discrete_parameter_values_final);
     }
   else
     {
       // Initialize the parameter ranges and the parameters themselves
       initialize_parameters(mu_min_in, mu_max_in, discrete_parameter_values_in);
     }
 
   bool updated_deterministic_training = deterministic_training_in;
   if (training_sample_list && (this->get_parameters_min().n_parameters() > 3))
     {
       // In this case we force deterministic_training to be false because
       // a) deterministic training samples are not currrently supported with
       //    more than 3 parameters, and
       // b) we will overwrite the training samples anyway in the call to
       //    load_training_set() below, so we do not want to generate an
       //    error due to deterministic training sample generation when
       //    the samples will be overwritten anyway.
       updated_deterministic_training = false;
     }
 
   initialize_training_parameters(this->get_parameters_min(),
                                  this->get_parameters_max(),
                                  n_training_samples_in,
                                  log_scaling_in,
                                  updated_deterministic_training);
 
   if (training_sample_list)
     {
       // Note that we must call initialize_training_parameters() before
       // load_training_set() in order to initialize the parameter vectors.
       load_training_set(*training_sample_list);
     }
 
 
   if (get_rb_eim_evaluation().get_parametrized_function().is_lookup_table)
     {
       // Also, now that we've initialized the training set, overwrite the training
       // samples to ensure that we have full coverage of the lookup tbale.
       const std::string & lookup_table_param_name =
         get_rb_eim_evaluation().get_parametrized_function().lookup_table_param_name;
 
       // Fill the lookup_table_training_samples with sequential single-entry vectors,
       // i.e. {{0.0}, {1.0}, {2.0}, ...}
       Real val = 0.0;
       std::vector<RBParameter> lookup_table_training_samples(n_training_samples_in, {val});
       for (auto & vec : lookup_table_training_samples)
         {
           vec[0] = val;
           val += 1.0;   // Could use val++, but better to be explicit for doubles.
         }
 
       set_training_parameter_values(lookup_table_param_name, lookup_table_training_samples);
     }
 }

◆ set_rb_eim_evaluation()

void libMesh::RBEIMConstruction::set_rb_eim_evaluation ( RBEIMEvaluation & rb_eim_eval_in )

inherited

Set the RBEIMEvaluation object.

Definition at line 152 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rb_eim_eval.

Referenced by main().

 {
   _rb_eim_eval = &rb_eim_eval_in;
 }

◆ set_rel_training_tolerance()

void libMesh::RBEIMConstruction::set_rel_training_tolerance ( Real new_training_tolerance )

inherited

Get/set the relative tolerance for the basis training.

Definition at line 1190 of file rb_eim_construction.C.

References libMesh::RBEIMConstruction::_rel_training_tolerance.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   _rel_training_tolerance = new_training_tolerance;
 }

◆ set_training_parameter_values()

void libMesh::RBConstructionBase< System >::set_training_parameter_values	(	const std::string &	param_name,
		const std::vector< RBParameter > &	values
	)

inherited

Overwrite the local training samples for param_name using values.

This assumes that values.size() matches get_local_n_training_samples().

Definition at line 456 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   libmesh_error_msg_if(!_training_parameters_initialized,
     "Training parameters must be initialized before calling set_training_parameter_values");
   libmesh_error_msg_if(values.size() != get_local_n_training_samples(),
     "Inconsistent sizes");
 
   // Copy the new data, overwriting the old data.
   auto & training_vector = libmesh_map_find(_training_parameters, param_name);
   training_vector = values;
 }

◆ set_training_random_seed()

void libMesh::RBConstructionBase< System >::set_training_random_seed ( int seed )

inherited

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

Definition at line 780 of file rb_construction_base.C.

Referenced by libMesh::RBEIMConstruction::set_rb_construction_parameters().

 {
   this->_training_parameters_random_seed = seed;
 }

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

Definition at line 1147 of file system.C.

References libMesh::System::_vector_is_adjoint.

Referenced by libMesh::System::add_adjoint_solution(), and libMesh::System::add_weighted_sensitivity_adjoint_solution().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   // We reserve -1 for vectors which get primal constraints, -2 for
   // vectors which get no constraints
   libmesh_assert_greater_equal(qoi_num, -2);
   _vector_is_adjoint[vec_name] = qoi_num;
 }

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

Definition at line 1125 of file system.C.

References libMesh::System::_vector_projections.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and main().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   _vector_projections[vec_name] = preserve;
 }

◆ solve()

virtual void libMesh::System::solve ( )

inlinevirtualinherited

Solves the system.

Should be overridden in derived systems.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::ImplicitSystem, libMesh::DifferentiableSystem, libMesh::LinearImplicitSystem, libMesh::VariationalSmootherSystem, libMesh::ExplicitSystem, libMesh::FEMSystem, libMesh::CondensedEigenSystem, libMesh::FrequencySystem, libMesh::EigenSystem, and libMesh::ContinuationSystem.

Definition at line 349 of file system.h.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), main(), and SystemsTest::testAssemblyWithDgFemContext().

349 {}

◆ solve_for_unconstrained_dofs()

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

inherited

Definition at line 2102 of file system_projection.C.

References libMesh::DofMap::build_sparsity(), libMesh::DofMap::computed_sparsity_already(), libMesh::DofMapBase::end_dof(), libMesh::DofMapBase::first_dof(), libMesh::NumericVector< T >::get(), libMesh::DofMap::heterogenously_constrain_element_matrix_and_vector(), libMesh::DofMap::is_constrained_dof(), libMesh::NumericVector< T >::local_size(), libMesh::DofMap::n_dofs(), libMesh::DofMap::n_local_dofs(), libMesh::PARALLEL, libMesh::Real, libMesh::NumericVector< T >::size(), and libMesh::DofMap::update_sparsity_pattern().

 {
   const DofMap & dof_map = this->get_dof_map();
 
   std::unique_ptr<SparseMatrix<Number>> mat =
     SparseMatrix<Number>::build(this->comm());
 
   std::unique_ptr<SparsityPattern::Build> sp;
 
   if (dof_map.computed_sparsity_already())
     dof_map.update_sparsity_pattern(*mat);
   else
     {
       mat->attach_dof_map(dof_map);
       sp = dof_map.build_sparsity(this->get_mesh());
       mat->attach_sparsity_pattern(*sp);
     }
 
   mat->init();
 
   libmesh_assert_equal_to(vec.size(), dof_map.n_dofs());
   libmesh_assert_equal_to(vec.local_size(), dof_map.n_local_dofs());
 
   std::unique_ptr<NumericVector<Number>> rhs =
     NumericVector<Number>::build(this->comm());
 
   rhs->init(dof_map.n_dofs(), dof_map.n_local_dofs(), false,
             PARALLEL);
 
   // Here we start with the unconstrained (and indeterminate) linear
   // system, K*u = f, where K is the identity matrix for constrained
   // DoFs and 0 elsewhere, and f is the current solution values for
   // constrained DoFs and 0 elsewhere.
   // We then apply the usual heterogeneous constraint matrix C and
   // offset h, where u = C*x + h,
   // to get C^T*K*C*x = C^T*f - C^T*K*h
   // - a constrained and no-longer-singular system that finds the
   // closest approximation for the unconstrained degrees of freedom.
   //
   // Here, though "closest" is in an algebraic sense; we're
   // effectively using a pseudoinverse that optimizes in a
   // discretization-dependent norm.  That only seems to give ~0.1%
   // excess error even in coarse unit test cases, but at some point it
   // might be reasonable to weight K and f properly.
 
   for (dof_id_type d : IntRange<dof_id_type>(dof_map.first_dof(),
                                              dof_map.end_dof()))
     {
       if (dof_map.is_constrained_dof(d))
         {
           DenseMatrix<Number> K(1,1);
           DenseVector<Number> F(1);
           std::vector<dof_id_type> dof_indices(1, d);
           K(0,0) = 1;
           F(0) = (*this->solution)(d);
           dof_map.heterogenously_constrain_element_matrix_and_vector
             (K, F, dof_indices, false, is_adjoint);
           mat->add_matrix(K, dof_indices);
           rhs->add_vector(F, dof_indices);
         }
     }
 
   std::unique_ptr<LinearSolver<Number>> linear_solver =
     LinearSolver<Number>::build(this->comm());
 
   linear_solver->solve(*mat, vec, *rhs,
                        double(this->get_equation_systems().parameters.get<Real>("linear solver tolerance")),
                        this->get_equation_systems().parameters.get<unsigned int>("linear solver maximum iterations"));
 }

◆ store_eim_solutions_for_training_set()

void libMesh::RBEIMConstruction::store_eim_solutions_for_training_set ( )

inherited

Get the EIM solution vector at all parametrized functions in the training set.

In some cases we want to store this data for future use. For example this is useful in the case that the parametrized function is defined based on a look-up table rather than an analytical function, since if we store the EIM solution data, we can do Online solves without initializing the look-up table data.

Definition at line 1237 of file rb_eim_construction.C.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation_with_greedy().

 {
   LOG_SCOPE("store_eim_solutions_for_training_set()", "RBEIMConstruction");
 
   RBEIMEvaluation & eim_eval = get_rb_eim_evaluation();
 
   std::vector<DenseVector<Number>> & eim_solutions = get_rb_eim_evaluation().get_eim_solutions_for_training_set();
   eim_solutions.clear();
   eim_solutions.resize(get_n_training_samples());
 
   unsigned int RB_size = get_rb_eim_evaluation().get_n_basis_functions();
 
   for (auto i : make_range(get_n_training_samples()))
     {
       if (eim_eval.get_parametrized_function().on_mesh_sides())
         {
           const auto & local_side_pf = _local_side_parametrized_functions_for_training[i];
 
           if (RB_size > 0)
             {
               // Get the right-hand side vector for the EIM approximation
               // by sampling the parametrized function (stored in solution)
               // at the interpolation points.
               DenseVector<Number> EIM_rhs(RB_size);
               for (unsigned int j=0; j<RB_size; j++)
                 {
                   EIM_rhs(j) =
                     RBEIMEvaluation::get_parametrized_function_side_value(comm(),
                                                                           local_side_pf,
                                                                           eim_eval.get_interpolation_points_elem_id(j),
                                                                           eim_eval.get_interpolation_points_side_index(j),
                                                                           eim_eval.get_interpolation_points_comp(j),
                                                                           eim_eval.get_interpolation_points_qp(j));
                 }
               eim_solutions[i] = eim_eval.rb_eim_solve(EIM_rhs);
             }
         }
       else if (eim_eval.get_parametrized_function().on_mesh_nodes())
         {
           const auto & local_node_pf = _local_node_parametrized_functions_for_training[i];
 
           if (RB_size > 0)
             {
               // Get the right-hand side vector for the EIM approximation
               // by sampling the parametrized function (stored in solution)
               // at the interpolation points.
               DenseVector<Number> EIM_rhs(RB_size);
               for (unsigned int j=0; j<RB_size; j++)
                 {
                   EIM_rhs(j) =
                     RBEIMEvaluation::get_parametrized_function_node_value(comm(),
                                                                           local_node_pf,
                                                                           eim_eval.get_interpolation_points_node_id(j),
                                                                           eim_eval.get_interpolation_points_comp(j));
                 }
               eim_solutions[i] = eim_eval.rb_eim_solve(EIM_rhs);
             }
         }
       else
         {
           const auto & local_pf = _local_parametrized_functions_for_training[i];
 
           if (RB_size > 0)
             {
               // Get the right-hand side vector for the EIM approximation
               // by sampling the parametrized function (stored in solution)
               // at the interpolation points.
               DenseVector<Number> EIM_rhs(RB_size);
               for (unsigned int j=0; j<RB_size; j++)
                 {
                   EIM_rhs(j) =
                     RBEIMEvaluation::get_parametrized_function_value(comm(),
                                                                     local_pf,
                                                                     eim_eval.get_interpolation_points_elem_id(j),
                                                                     eim_eval.get_interpolation_points_comp(j),
                                                                     eim_eval.get_interpolation_points_qp(j));
                 }
               eim_solutions[i] = eim_eval.rb_eim_solve(EIM_rhs);
             }
         }
     }
 }

◆ system()

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

inlineinherited

Returns: A reference to *this.

Definition at line 87 of file rb_construction_base.h.

87 { return *this; }

◆ system_type()

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

inlinevirtualinherited

Returns: The type of system, helpful in identifying which system type to use when reading equation system data from file. Should be overridden in derived classes.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::LinearImplicitSystem, libMesh::RBConstruction, libMesh::EigenSystem, libMesh::FrequencySystem, libMesh::ExplicitSystem, libMesh::ImplicitSystem, libMesh::TransientSystem< RBConstruction >, libMesh::NewmarkSystem, libMesh::ClawSystem, and SolidSystem.

Definition at line 510 of file system.h.

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

510 { return "Basic"; }

◆ train_eim_approximation()

Real libMesh::RBEIMConstruction::train_eim_approximation ( )

virtualinherited

Generate the EIM approximation for the specified parametrized function using either POD or the Greedy Algorithm.

Return the final tolerance.

Definition at line 416 of file rb_eim_construction.C.

References libMesh::RBConstructionBase< System >::_normalize_solution_snapshots, libMesh::RBEIMConstruction::apply_normalization_to_solution_snapshots(), libMesh::RBEIMConstruction::best_fit_type_flag, libMesh::RBEIMConstruction::POD_BEST_FIT, libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

Referenced by main().

 {
   if (_normalize_solution_snapshots)
     apply_normalization_to_solution_snapshots();
 
   if(best_fit_type_flag == POD_BEST_FIT)
     {
       train_eim_approximation_with_POD();
       return 0.;
     }
   else
     {
       return train_eim_approximation_with_greedy();
     }
 }

◆ train_eim_approximation_with_greedy()

Real libMesh::RBEIMConstruction::train_eim_approximation_with_greedy ( )

virtualinherited

Generate the EIM approximation for the specified parametrized function using the Greedy Algorithm.

Return the final tolerance. Method is virtual so that behavior can be specialized further in subclasses, if needed.

Definition at line 432 of file rb_eim_construction.C.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation().

 {
   LOG_SCOPE("train_eim_approximation_with_greedy()", "RBEIMConstruction");
 
   RBEIMEvaluation & rbe = get_rb_eim_evaluation();
 
   // We need space for one extra interpolation point if we're using the
   // EIM error indicator.
   unsigned int max_matrix_size = rbe.use_eim_error_indicator() ? get_Nmax()+1 : get_Nmax();
   _eim_projection_matrix.resize(max_matrix_size,max_matrix_size);
 
   rbe.initialize_parameters(*this);
   rbe.resize_data_structures(max_matrix_size);
 
   // If we are continuing from a previous training run,
   // we might already be at the max number of basis functions.
   // If so, we can just return.
   libmesh_error_msg_if(rbe.get_n_basis_functions() > 0,
                        "Error: We currently only support EIM training starting from an empty basis");
 
   libMesh::out << std::endl << "---- Performing Greedy EIM basis enrichment ----" << std::endl;
 
   if (_max_abs_value_in_training_set <= get_abs_training_tolerance())
   {
     std::cout << "Maximum absolute value in the training set is "
       << _max_abs_value_in_training_set << ", which is less than or equal to the abs. training tolerance of "
       << get_abs_training_tolerance() << ", hence exiting Greedy basis enrichment with empty basis" << std::endl;
     return 0.0;
   }
 
   // Initialize greedy_error so that we do not incorrectly set is_zero_bf=true on
   // the first iteration.
   Real greedy_error = -1.;
   std::vector<RBParameters> greedy_param_list;
 
   // Initialize the current training index to the index that corresponds
   // to the largest (in terms of infinity norm) function in the training set.
   // We do this to ensure that the first EIM basis function is not zero.
   unsigned int current_training_index = _max_abs_value_in_training_set_index;
   set_params_from_training_set(current_training_index);
 
   // We use this boolean to indicate if we will run one more iteration
   // before exiting the loop below. We use this when computing the EIM
   // error indicator, which requires one extra EIM iteration.
   bool exit_on_next_iteration = false;
 
   // We also initialize a boolean to keep track of whether we have
   // reached "n_samples" EIM basis functions, since we need to
   // handle the EIM error indicator in a special way in this case.
   bool bfs_equals_n_samples = false;
 
   while (true)
     {
       if (rbe.get_n_basis_functions() >= get_n_training_samples())
         {
           libMesh::out << "Number of basis functions (" << rbe.get_n_basis_functions()
             << ") equals number of training samples." << std::endl;
 
           bfs_equals_n_samples = true;
 
           // If exit_on_next_iteration==true then we don't exit yet, since
           // we still need to add data for the error indicator before exiting.
           if (!exit_on_next_iteration)
             break;
         }
 
       libMesh::out << "Greedily selected parameter vector:" << std::endl;
       print_parameters();
       greedy_param_list.emplace_back(get_parameters());
 
       libMesh::out << "Enriching the EIM approximation" << std::endl;
       libmesh_try
         {
           bool is_zero_bf = bfs_equals_n_samples || (greedy_error == 0.);
 
           // If is_zero_bf==true then we add an "extra point" because we
           // cannot add a usual EIM interpolation point in that case since
           // the full EIM space is already covered. This is necessary when we
           // want to add an extra point for error indicator purposes in the
           // is_zero_bf==true case, for example.
           std::unique_ptr<EimPointData> eim_point_data;
           if (is_zero_bf)
               eim_point_data = std::make_unique<EimPointData>(get_random_point_from_training_sample());
 
           // If exit_on_next_iteration==true then we do not add a basis function in
           // that case since in that case we only need to add data for the EIM error
           // indicator.
           enrich_eim_approximation(current_training_index,
                                    /*add_basis_function*/ !exit_on_next_iteration,
                                    eim_point_data.get());
           update_eim_matrices(/*set_error_indicator*/ exit_on_next_iteration);
 
           libMesh::out << std::endl << "---- Basis dimension: "
                       << rbe.get_n_basis_functions() << " ----" << std::endl;
 
           if (get_rb_eim_evaluation().get_parametrized_function().is_lookup_table &&
               best_fit_type_flag == EIM_BEST_FIT)
             {
               // If this is a lookup table and we're using "EIM best fit" then we
               // need to update the eim_solutions after each EIM enrichment so that
               // we can call rb_eim_eval.rb_eim_solve() from within compute_max_eim_error().
               store_eim_solutions_for_training_set();
             }
 
           libMesh::out << "Computing EIM error on training set" << std::endl;
           std::tie(greedy_error, current_training_index) = compute_max_eim_error();
           set_params_from_training_set(current_training_index);
 
           libMesh::out << "Maximum EIM error is " << greedy_error << std::endl << std::endl;
         }
 #ifdef LIBMESH_ENABLE_EXCEPTIONS
       catch (const std::exception & e)
         {
           // If we hit an exception when performing the enrichment for the error indicator, then
           // we just continue and skip the error indicator. Otherwise we rethrow the exception.
           if (exit_on_next_iteration)
             {
               std::cout << "Exception occurred when enriching basis for error indicator hence we skip the error indicator in this case" << std::endl;
               break;
             }
           else
             throw;
         }
 #endif
 
       if (exit_on_next_iteration)
         {
           libMesh::out << "Extra EIM iteration for error indicator is complete, hence exiting EIM training now" << std::endl;
           break;
         }
 
       // Convergence and/or termination tests
       {
         bool exit_condition_satisfied = false;
 
         if (rbe.get_n_basis_functions() >= this->get_Nmax())
           {
             libMesh::out << "Maximum number of basis functions reached: Nmax = "
                           << get_Nmax() << std::endl;
             exit_condition_satisfied = true;
           }
 
         // We consider the relative tolerance as relative to the maximum value in the training
         // set, since we assume that this maximum value provides a relevant scaling.
         if (!exit_condition_satisfied)
           if (greedy_error < (get_rel_training_tolerance() * get_max_abs_value_in_training_set()))
             {
               libMesh::out << "Relative error tolerance reached." << std::endl;
               exit_condition_satisfied = true;
             }
 
         if (!exit_condition_satisfied)
           if (greedy_error < get_abs_training_tolerance())
             {
               libMesh::out << "Absolute error tolerance reached." << std::endl;
               exit_condition_satisfied = true;
             }
 
         bool has_parameters = (get_parameters().n_parameters() > 0);
         if (!exit_condition_satisfied)
         {
           bool do_exit = false;
           // In the check for repeated parameters we have to make sure this isn't a case
           // with no parameters, since in that case we would always report repeated
           // parameters.
           for (auto & param : greedy_param_list)
             if (param == get_parameters() && has_parameters)
               {
                 libMesh::out << "Exiting greedy because the same parameters were selected twice"
                              << std::endl;
                 do_exit = true;
                 break;
               }
 
           if (do_exit)
             exit_condition_satisfied = true;
         }
 
         if (exit_condition_satisfied)
           {
             // If we're using the EIM error indicator then we need to run
             // one extra EIM iteration since we use the extra EIM point
             // to obtain our error indicator. If we're not using the EIM
             // error indicator, then we just exit now.
             if (get_rb_eim_evaluation().use_eim_error_indicator() && has_parameters)
               {
                 exit_on_next_iteration = true;
                 libMesh::out << "EIM error indicator is active, hence we will run one extra EIM iteration before exiting"
                              << std::endl;
               }
             else
               break;
           }
       }
     } // end while(true)
 
   if (rbe.get_parametrized_function().is_lookup_table &&
       best_fit_type_flag != EIM_BEST_FIT)
     {
       // We only enter here if best_fit_type_flag != EIM_BEST_FIT because we
       // already called this above in the EIM_BEST_FIT case.
       store_eim_solutions_for_training_set();
     }
 
   return greedy_error;
 }

◆ train_eim_approximation_with_POD()

Real libMesh::RBEIMConstruction::train_eim_approximation_with_POD ( )

virtualinherited

Generate the EIM approximation for the specified parametrized function using Proper Orthogonal Decomposition (POD).

Return the final tolerance. Method is virtual so that behavior can be specialized further in subclasses, if needed.

Definition at line 703 of file rb_eim_construction.C.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation().

 {
   LOG_SCOPE("train_eim_approximation_with_POD()", "RBEIMConstruction");
 
   RBEIMEvaluation & rbe = get_rb_eim_evaluation();
 
   unsigned int n_snapshots = get_n_training_samples();
 
   // If _set_Nmax_from_n_snapshots=true, then we overrule Nmax.
   if (_set_Nmax_from_n_snapshots)
   {
     int updated_Nmax = (static_cast<int>(n_snapshots) + _Nmax_from_n_snapshots_increment);
 
     // We only overrule _Nmax if updated_Nmax is positive, since if Nmax=0 then we'll skip
     // training here entirely, which is typically not what we want.
     if (updated_Nmax > 0)
       _Nmax = static_cast<unsigned int>(updated_Nmax);
   }
 
   // _eim_projection_matrix is not used in the POD case, but we resize it here in any case
   // to be consistent with what we do in train_eim_approximation_with_greedy().
   // We need space for one extra interpolation point if we're using the
   // EIM error indicator.
   unsigned int max_matrix_size = rbe.use_eim_error_indicator() ? get_Nmax()+1 : get_Nmax();
   _eim_projection_matrix.resize(max_matrix_size,max_matrix_size);
 
   rbe.initialize_parameters(*this);
   rbe.resize_data_structures(get_Nmax());
 
   libmesh_error_msg_if(rbe.get_n_basis_functions() > 0,
                        "Error: We currently only support EIM training starting from an empty basis");
 
   libMesh::out << std::endl << "---- Performing POD EIM basis enrichment ----" << std::endl;
 
   // Set up the POD "correlation matrix". This enables us to compute the POD via the
   // "method of snapshots", in which we compute a low rank representation of the
   // n_snapshots x n_snapshots matrix.
   DenseMatrix<Number> correlation_matrix(n_snapshots,n_snapshots);
 
   std::cout << "Start computing correlation matrix" << std::endl;
 
   bool apply_comp_scaling = !get_rb_eim_evaluation().scale_components_in_enrichment().empty();
   for (unsigned int i=0; i<n_snapshots; i++)
     {
       for (unsigned int j=0; j<=i; j++)
         {
           Number inner_prod = 0.;
           if (rbe.get_parametrized_function().on_mesh_sides())
             {
               inner_prod = side_inner_product(
                 _local_side_parametrized_functions_for_training[i],
                 _local_side_parametrized_functions_for_training[j],
                 apply_comp_scaling);
             }
           else if (rbe.get_parametrized_function().on_mesh_nodes())
             {
               inner_prod = node_inner_product(
                 _local_node_parametrized_functions_for_training[i],
                 _local_node_parametrized_functions_for_training[j],
                 apply_comp_scaling);
             }
           else
             {
               inner_prod = inner_product(
                 _local_parametrized_functions_for_training[i],
                 _local_parametrized_functions_for_training[j],
                 apply_comp_scaling);
             }
 
 
           correlation_matrix(i,j) = inner_prod;
           if(i != j)
             {
               correlation_matrix(j,i) = libmesh_conj(inner_prod);
             }
         }
 
       // Print out every 10th row so that we can see the progress
       if ( (i+1) % 10 == 0)
         std::cout << "Finished row " << (i+1) << " of " << n_snapshots << std::endl;
     }
   std::cout << "Finished computing correlation matrix" << std::endl;
 
   // Compute SVD of correlation matrix.
   // Let Y = U S V^T, then the SVD below corresponds
   // to Y^T Y = V S U^T U S V^T = V S^2 V^T.
   // The POD basis we use is then given by U, which
   // we can compute via U = Y V S^{-1}, which is what
   // we compute below.
   //
   // Note that the formulation remains the same in the
   // case that we use a weighted inner product (as
   // in the case that we used apply_comp_scaling=true
   // when computing the correlation matrix), see (1.28)
   // from the lecture notes from Volkwein on POD for more
   // details.
   DenseVector<Real> sigma( n_snapshots );
   DenseMatrix<Number> U( n_snapshots, n_snapshots );
   DenseMatrix<Number> VT( n_snapshots, n_snapshots );
   correlation_matrix.svd(sigma, U, VT );
 
   // We use this boolean to indicate if we will run one more iteration
   // before exiting the loop below. We use this when computing the EIM
   // error indicator, which requires one extra EIM iteration.
   bool exit_on_next_iteration = false;
 
   // Add dominant vectors from the POD as basis functions.
   unsigned int j = 0;
   Real rel_err = 0.;
 
   // We also initialize a boolean to keep track of whether we have
   // reached "n_snapshots" EIM basis functions, since we need to
   // handle the EIM error indicator in a special way in this case.
   bool j_equals_n_snapshots = false;
   while (true)
     {
       bool exit_condition_satisfied = false;
 
       if ((j == 0) && (sigma(0) == 0.))
       {
         libMesh::out << "Terminating EIM POD with empty basis because first singular value is zero" << std::endl;
         exit_condition_satisfied = true;
         rel_err = 0.;
       }
       else if (j >= n_snapshots)
         {
           libMesh::out << "Number of basis functions equals number of training samples." << std::endl;
           exit_condition_satisfied = true;
           j_equals_n_snapshots = true;
 
           // In this case we set the rel. error to be zero since we've filled up the
           // entire space. We cannot use the formula below for rel_err since
           // sigma(n_snapshots) is not defined.
           rel_err = 0.;
         }
       else
         {
           // The "energy" error in the POD approximation is determined by the first omitted
           // singular value, i.e. sigma(j). We normalize by sigma(0), which gives the total
           // "energy", in order to obtain a relative error.
           rel_err = std::sqrt(sigma(j)) / std::sqrt(sigma(0));
         }
 
       if (exit_on_next_iteration)
         {
           libMesh::out << "Extra EIM iteration for error indicator is complete, POD error norm for extra iteration: " << rel_err << std::endl;
           break;
         }
 
       libMesh::out << "Number of basis functions: " << j
                    << ", POD error norm: " << rel_err << std::endl;
 
       if (!exit_condition_satisfied)
         if (j >= get_Nmax())
           {
             libMesh::out << "Maximum number of basis functions (" << j << ") reached." << std::endl;
             exit_condition_satisfied = true;
           }
 
       if (!exit_condition_satisfied)
         if (rel_err < get_rel_training_tolerance())
           {
             libMesh::out << "Training tolerance reached." << std::endl;
             exit_condition_satisfied = true;
           }
 
       if (exit_condition_satisfied)
         {
           // If we're using the EIM error indicator then we need to run
           // one extra EIM iteration since we use the extra EIM point
           // to obtain our error indicator. If we're not using the EIM
           // error indicator, then we just exit now.
           bool has_parameters = (get_parameters().n_parameters() > 0);
           if (get_rb_eim_evaluation().use_eim_error_indicator() && has_parameters)
             {
               exit_on_next_iteration = true;
               libMesh::out << "EIM error indicator is active, hence we will run one extra EIM iteration before exiting"
                             << std::endl;
             }
           else
             break;
         }
 
       bool is_zero_bf = j_equals_n_snapshots || (rel_err == 0.);
       if (rbe.get_parametrized_function().on_mesh_sides())
         {
           // Make a "zero clone" by copying to get the same data layout, and then scaling by zero
           SideQpDataMap v = _local_side_parametrized_functions_for_training[0];
 
           if (!is_zero_bf)
             {
               scale_parametrized_function(v, 0.);
 
               for ( unsigned int i=0; i<n_snapshots; ++i )
                 add(v, U.el(i, j), _local_side_parametrized_functions_for_training[i] );
 
               Real norm_v = std::sqrt(sigma(j));
               scale_parametrized_function(v, 1./norm_v);
             }
 
           libmesh_try
             {
               // If is_zero_bf==true then we add an "extra point" because we cannot
               // add a usual EIM interpolation point in that case since the full EIM
               // space is already covered. This is necessary when we want to add an
               // extra point for error indicator purposes in the is_zero_bf==true
               // case, for example.
               std::unique_ptr<EimPointData> eim_point_data;
               if (is_zero_bf)
                   eim_point_data = std::make_unique<EimPointData>(get_random_point(v));
 
               // If exit_on_next_iteration==true then we do not add a basis function in
               // that case since in that case we only need to add data for the EIM error
               // indicator.
               bool is_linearly_dependent = enrich_eim_approximation_on_sides(v,
                                                                              /*add_basis_function*/ !exit_on_next_iteration,
                                                                              eim_point_data.get());
 
               // If we encountered linearly dependent data, then we treat this the same as
               // when we have exit_condition_satisfied==true because the EIM training cannot
               // proceed any further. As a result, we set exit_on_next_iteration=true here,
               // as we do above in the case that exit_condition_satisfied==true.
               if (is_linearly_dependent)
               {
                 bool has_parameters = (get_parameters().n_parameters() > 0);
                 if (get_rb_eim_evaluation().use_eim_error_indicator() && has_parameters)
                   {
                     exit_on_next_iteration = true;
                     libMesh::out << "Linearly dependent data detected, finalizing iteration for the EIM error indicator before exiting"
                                   << std::endl;
                   }
                 else
                   break;
               }
 
               if (is_linearly_dependent && !is_zero_bf)
                 {
                   // In this case we detected that v is actually linearly dependent and that is_zero_bf
                   // was previously not correct --- it should have been true. We typically
                   // catch this earlier (e.g. by checking rel_err) but in some cases we do not catch
                   // this until we call the enrichment method. In this situation we update is_zero_bf
                   // to true and call the enrichment again.
                   is_zero_bf = true;
                   eim_point_data = std::make_unique<EimPointData>(get_random_point(v));
 
                   enrich_eim_approximation_on_sides(v,
                                                     /*add_basis_function*/ !exit_on_next_iteration,
                                                     eim_point_data.get());
                 }
 
               update_eim_matrices(/*set_error_indicator*/ exit_on_next_iteration);
             }
 #ifdef LIBMESH_ENABLE_EXCEPTIONS
           catch (const std::exception & e)
             {
               // If we hit an exception when performing the enrichment for the error indicator, then
               // we just continue and skip the error indicator. Otherwise we rethrow the exception.
               if (exit_on_next_iteration)
                 {
                   std::cout << "Exception occurred when enriching basis for error indicator hence we skip the error indicator in this case" << std::endl;
                   break;
                 }
               else
                 throw;
             }
 #endif
         }
       else if (rbe.get_parametrized_function().on_mesh_nodes())
         {
           // Make a "zero clone" by copying to get the same data layout, and then scaling by zero
           NodeDataMap v = _local_node_parametrized_functions_for_training[0];
 
           if (!is_zero_bf)
             {
               scale_node_parametrized_function(v, 0.);
 
               for ( unsigned int i=0; i<n_snapshots; ++i )
                 add_node_data_map(v, U.el(i, j), _local_node_parametrized_functions_for_training[i] );
 
               Real norm_v = std::sqrt(sigma(j));
               scale_node_parametrized_function(v, 1./norm_v);
             }
 
           libmesh_try
             {
               // If is_zero_bf==true then we add an "extra point" because we cannot
               // add a usual EIM interpolation point in that case since the full EIM
               // space is already covered. This is necessary when we want to add an
               // extra point for error indicator purposes in the is_zero_bf==true
               // case, for example.
               std::unique_ptr<EimPointData> eim_point_data;
               if (is_zero_bf)
                   eim_point_data = std::make_unique<EimPointData>(get_random_point(v));
 
               // If exit_on_next_iteration==true then we do not add a basis function in
               // that case since in that case we only need to add data for the EIM error
               // indicator.
               bool is_linearly_dependent = enrich_eim_approximation_on_nodes(v,
                                                                              /*add_basis_function*/ !exit_on_next_iteration,
                                                                              eim_point_data.get());
 
               // If we encountered linearly dependent data, then we treat this the same as
               // when we have exit_condition_satisfied==true because the EIM training cannot
               // proceed any further. As a result, we set exit_on_next_iteration=true here,
               // as we do above in the case that exit_condition_satisfied==true.
               if (is_linearly_dependent)
               {
                 bool has_parameters = (get_parameters().n_parameters() > 0);
                 if (get_rb_eim_evaluation().use_eim_error_indicator() && has_parameters)
                   {
                     exit_on_next_iteration = true;
                     libMesh::out << "Linearly dependent data detected, finalizing iteration for the EIM error indicator before exiting"
                                   << std::endl;
                   }
                 else
                   break;
               }
 
               if (is_linearly_dependent && !is_zero_bf)
                 {
                   // In this case we detected that v is actually linearly dependent and that is_zero_bf
                   // was previously not correct --- it should have been true. We typically
                   // catch this earlier (e.g. by checking rel_err) but in some cases we do not catch
                   // this until we call the enrichment method. In this situation we update is_zero_bf
                   // to true and call the enrichment again.
                   is_zero_bf = true;
                   eim_point_data = std::make_unique<EimPointData>(get_random_point(v));
 
                   enrich_eim_approximation_on_nodes(v,
                                                     /*add_basis_function*/ !exit_on_next_iteration,
                                                     eim_point_data.get());
                 }
 
               update_eim_matrices(/*set_error_indicator*/ exit_on_next_iteration);
             }
 #ifdef LIBMESH_ENABLE_EXCEPTIONS
           catch (const std::exception & e)
             {
               // If we hit an exception when performing the enrichment for the error indicator, then
               // we just continue and skip the error indicator. Otherwise we rethrow the exception.
               if (exit_on_next_iteration)
                 {
                   std::cout << "Exception occurred when enriching basis for error indicator hence we skip the error indicator in this case" << std::endl;
                   break;
                 }
               else
                 throw;
             }
 #endif
         }
       else
         {
           // Make a "zero clone" by copying to get the same data layout, and then scaling by zero
           QpDataMap v = _local_parametrized_functions_for_training[0];
 
           if (!is_zero_bf)
             {
               scale_parametrized_function(v, 0.);
 
               for ( unsigned int i=0; i<n_snapshots; ++i )
                 add(v, U.el(i, j), _local_parametrized_functions_for_training[i] );
 
               Real norm_v = std::sqrt(sigma(j));
               scale_parametrized_function(v, 1./norm_v);
             }
 
           libmesh_try
             {
               // If is_zero_bf==true then we add an "extra point" because we cannot
               // add a usual EIM interpolation point in that case since the full EIM
               // space is already covered. This is necessary when we want to add an
               // extra point for error indicator purposes in the is_zero_bf==true
               // case, for example.
               std::unique_ptr<EimPointData> eim_point_data;
               if (is_zero_bf)
                   eim_point_data = std::make_unique<EimPointData>(get_random_point(v));
 
               // If exit_on_next_iteration==true then we do not add a basis function in
               // that case since in that case we only need to add data for the EIM error
               // indicator.
               bool is_linearly_dependent = enrich_eim_approximation_on_interiors(v,
                                                                                  /*add_basis_function*/ !exit_on_next_iteration,
                                                                                  eim_point_data.get());
 
               // If we encountered linearly dependent data, then we treat this the same as
               // when we have exit_condition_satisfied==true because the EIM training cannot
               // proceed any further. As a result, we set exit_on_next_iteration=true here,
               // as we do above in the case that exit_condition_satisfied==true.
               if (is_linearly_dependent)
               {
                 bool has_parameters = (get_parameters().n_parameters() > 0);
                 if (get_rb_eim_evaluation().use_eim_error_indicator() && has_parameters)
                   {
                     exit_on_next_iteration = true;
                     libMesh::out << "Linearly dependent data detected, finalizing iteration for the EIM error indicator before exiting"
                                   << std::endl;
                   }
                 else
                   break;
               }
 
               if (is_linearly_dependent && !is_zero_bf)
                 {
                   // In this case we detected that v is actually linearly dependent and that is_zero_bf
                   // was previously not correct --- it should have been true. We typically
                   // catch this earlier (e.g. by checking rel_err) but in some cases we do not catch
                   // this until we call the enrichment method. In this situation we update is_zero_bf
                   // to true and call the enrichment again.
                   is_zero_bf = true;
                   eim_point_data = std::make_unique<EimPointData>(get_random_point(v));
 
                   enrich_eim_approximation_on_interiors(v,
                                                         /*add_basis_function*/ !exit_on_next_iteration,
                                                         eim_point_data.get());
                 }
 
               update_eim_matrices(/*set_error_indicator*/ exit_on_next_iteration);
             }
 #ifdef LIBMESH_ENABLE_EXCEPTIONS
           catch (const std::exception & e)
             {
               // If we hit an exception when performing the enrichment for the error indicator, then
               // we just continue and skip the error indicator. Otherwise we rethrow the exception.
               if (exit_on_next_iteration)
                 {
                   std::cout << "Exception occurred when enriching basis for error indicator hence we skip the error indicator in this case" << std::endl;
                   break;
                 }
               else
                 throw;
             }
 #endif
         }
 
       if (is_zero_bf)
         {
           // In this case we exit here instead of increment j and continuing because
           // if we've encountered a zero EIM basis function then we must not have
           // any more valid data to add.
           std::cout << "Zero basis function encountered, hence exiting." << std::endl;
           break;
         }
 
       j++;
     }
   libMesh::out << std::endl;
 
   return rel_err;
 }

◆ update()

void libMesh::System::update ( )

virtualinherited

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

Reimplemented in SolidSystem.

Definition at line 498 of file system.C.

References libMesh::System::_dof_map, libMesh::System::current_local_solution, libMesh::libmesh_assert(), and libMesh::System::solution.

Referenced by libMesh::__libmesh_petsc_diff_solver_jacobian(), libMesh::__libmesh_petsc_diff_solver_residual(), libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::FEMSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::NonlinearImplicitSystem::assembly(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::NewmarkSolver::compute_initial_accel(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), libMesh::Problem_Interface::computeF(), libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::Nemesis_IO::copy_scalar_solution(), libMesh::ExodusII_IO::copy_scalar_solution(), DMlibMeshFunction(), DMlibMeshJacobian(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::CondensedEigenSystem::get_eigenpair(), libMesh::TransientRBConstruction::initialize_truth(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::libmesh_petsc_snes_fd_residual(), libMesh::libmesh_petsc_snes_jacobian(), libMesh::libmesh_petsc_snes_mffd_residual(), libMesh::libmesh_petsc_snes_residual(), libMesh::libmesh_petsc_snes_residual_helper(), libMesh::NewtonSolver::line_search(), libMesh::RBConstruction::load_basis_function(), libMesh::TransientRBConstruction::load_rb_solution(), libMesh::RBConstruction::load_rb_solution(), main(), libMesh::FEMSystem::mesh_position_get(), HeatSystem::perturb_accumulate_residuals(), libMesh::ErrorVector::plot_error(), libMesh::FEMSystem::postprocess(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::MemorySolutionHistory::retrieve(), libMesh::FileSolutionHistory::retrieve(), libMesh::NewtonSolver::solve(), libMesh::ExplicitSystem::solve(), libMesh::LinearImplicitSystem::solve(), libMesh::OptimizationSystem::solve(), libMesh::NonlinearImplicitSystem::solve(), libMesh::ClawSystem::solve_conservation_law(), libMesh::RBConstruction::solve_for_matrix_and_rhs(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::DirectSolutionTransfer::transfer(), and update_current_local_solution().

 {
   parallel_object_only();
 
   libmesh_assert(solution->closed());
 
   const std::vector<dof_id_type> & send_list = _dof_map->get_send_list ();
 
   // Check sizes
   libmesh_assert_equal_to (current_local_solution->size(), solution->size());
   // More processors than elements => empty send_list
   //  libmesh_assert (!send_list.empty());
   libmesh_assert_less_equal (send_list.size(), solution->size());
 
   // Create current_local_solution from solution.  This will
   // put a local copy of solution into current_local_solution.
   // Only the necessary values (specified by the send_list)
   // are copied to minimize communication
   solution->localize (*current_local_solution, send_list);
 }

◆ update_eim_matrices()

void libMesh::RBEIMConstruction::update_eim_matrices ( bool set_eim_error_indicator )

protectedinherited

Update the matrices used in training the EIM approximation.

If set_eim_error_indicator is true then we add data corresponding to the EIM error indicator.

Definition at line 2909 of file rb_eim_construction.C.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation_with_greedy(), and libMesh::RBEIMConstruction::train_eim_approximation_with_POD().

 {
   LOG_SCOPE("update_eim_matrices()", "RBEIMConstruction");
 
   RBEIMEvaluation & eim_eval = get_rb_eim_evaluation();
   unsigned int RB_size = eim_eval.get_n_basis_functions();
 
   libmesh_assert_msg(RB_size >= 1, "Must have at least 1 basis function.");
 
   if (set_eim_error_indicator)
     {
       // Here we have RB_size EIM basis functions, and RB_size+1 interpolation points,
       // since we should have added one extra interpolation point for the EIM error
       // indicator. As a result, we use RB_size as the index to access the (RB_size+1)^th
       // interpolation point in the calls to eim_eval.get_interpolation_points_*.
       DenseVector<Number> extra_point_row(RB_size);
 
       if (eim_eval.get_parametrized_function().on_mesh_sides())
         {
           // update the EIM interpolation matrix
           for (unsigned int j=0; j<RB_size; j++)
             {
               // Evaluate the basis functions at the new interpolation point in order
               // to update the interpolation matrix
               Number value =
                 eim_eval.get_eim_basis_function_side_value(j,
                                                            eim_eval.get_interpolation_points_elem_id(RB_size),
                                                            eim_eval.get_interpolation_points_side_index(RB_size),
                                                            eim_eval.get_interpolation_points_comp(RB_size),
                                                            eim_eval.get_interpolation_points_qp(RB_size));
               extra_point_row(j) = value;
             }
         }
       else if (eim_eval.get_parametrized_function().on_mesh_nodes())
         {
           // update the EIM interpolation matrix
           for (unsigned int j=0; j<RB_size; j++)
             {
               // Evaluate the basis functions at the new interpolation point in order
               // to update the interpolation matrix
               Number value =
                 eim_eval.get_eim_basis_function_node_value(j,
                                                            eim_eval.get_interpolation_points_node_id(RB_size),
                                                            eim_eval.get_interpolation_points_comp(RB_size));
               extra_point_row(j) = value;
             }
         }
       else
         {
           // update the EIM interpolation matrix
           for (unsigned int j=0; j<RB_size; j++)
             {
               // Evaluate the basis functions at the new interpolation point in order
               // to update the interpolation matrix
               Number value =
                 eim_eval.get_eim_basis_function_value(j,
                                                       eim_eval.get_interpolation_points_elem_id(RB_size),
                                                       eim_eval.get_interpolation_points_comp(RB_size),
                                                       eim_eval.get_interpolation_points_qp(RB_size));
               extra_point_row(j) = value;
             }
         }
 
       eim_eval.set_error_indicator_interpolation_row(extra_point_row);
       return;
     }
 
   if (eim_eval.get_parametrized_function().on_mesh_sides())
     {
       // update the matrix that is used to evaluate L2 projections
       // into the EIM approximation space
       for (unsigned int i=(RB_size-1); i<RB_size; i++)
         {
           for (unsigned int j=0; j<RB_size; j++)
             {
               Number value = side_inner_product(eim_eval.get_side_basis_function(j),
                                                 eim_eval.get_side_basis_function(i),
                                                 /*apply_comp_scaling*/ false);
 
               _eim_projection_matrix(i,j) = value;
               if (i!=j)
                 {
                   // The inner product matrix is assumed to be hermitian
                   _eim_projection_matrix(j,i) = libmesh_conj(value);
                 }
             }
         }
 
       // update the EIM interpolation matrix
       for (unsigned int j=0; j<RB_size; j++)
         {
           // Evaluate the basis functions at the new interpolation point in order
           // to update the interpolation matrix
           Number value =
             eim_eval.get_eim_basis_function_side_value(j,
                                                        eim_eval.get_interpolation_points_elem_id(RB_size-1),
                                                        eim_eval.get_interpolation_points_side_index(RB_size-1),
                                                        eim_eval.get_interpolation_points_comp(RB_size-1),
                                                        eim_eval.get_interpolation_points_qp(RB_size-1));
           eim_eval.set_interpolation_matrix_entry(RB_size-1, j, value);
         }
     }
   else if (eim_eval.get_parametrized_function().on_mesh_nodes())
     {
       // update the matrix that is used to evaluate L2 projections
       // into the EIM approximation space
       for (unsigned int i=(RB_size-1); i<RB_size; i++)
         {
           for (unsigned int j=0; j<RB_size; j++)
             {
               Number value = node_inner_product(eim_eval.get_node_basis_function(j),
                                                 eim_eval.get_node_basis_function(i),
                                                 /*apply_comp_scaling*/ false);
 
               _eim_projection_matrix(i,j) = value;
               if (i!=j)
                 {
                   // The inner product matrix is assumed to be hermitian
                   _eim_projection_matrix(j,i) = libmesh_conj(value);
                 }
             }
         }
 
       // update the EIM interpolation matrix
       for (unsigned int j=0; j<RB_size; j++)
         {
           // Evaluate the basis functions at the new interpolation point in order
           // to update the interpolation matrix
           Number value =
             eim_eval.get_eim_basis_function_node_value(j,
                                                        eim_eval.get_interpolation_points_node_id(RB_size-1),
                                                        eim_eval.get_interpolation_points_comp(RB_size-1));
           eim_eval.set_interpolation_matrix_entry(RB_size-1, j, value);
         }
     }
   else
     {
       // update the matrix that is used to evaluate L2 projections
       // into the EIM approximation space
       for (unsigned int i=(RB_size-1); i<RB_size; i++)
         {
           for (unsigned int j=0; j<RB_size; j++)
             {
               Number value = inner_product(eim_eval.get_basis_function(j),
                                            eim_eval.get_basis_function(i),
                                            /*apply_comp_scaling*/ false);
 
               _eim_projection_matrix(i,j) = value;
               if (i!=j)
                 {
                   // The inner product matrix is assumed to be hermitian
                   _eim_projection_matrix(j,i) = libmesh_conj(value);
                 }
             }
         }
 
       // update the EIM interpolation matrix
       for (unsigned int j=0; j<RB_size; j++)
         {
           // Evaluate the basis functions at the new interpolation point in order
           // to update the interpolation matrix
           Number value =
             eim_eval.get_eim_basis_function_value(j,
                                                   eim_eval.get_interpolation_points_elem_id(RB_size-1),
                                                   eim_eval.get_interpolation_points_comp(RB_size-1),
                                                   eim_eval.get_interpolation_points_qp(RB_size-1));
           eim_eval.set_interpolation_matrix_entry(RB_size-1, j, value);
         }
     }
 }

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

Definition at line 733 of file system.C.

References libMesh::System::solution.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::ExactErrorEstimator::estimate_error(), main(), and libMesh::InterMeshProjection::project_system_vectors().

 {
   parallel_object_only();
 
   global_soln.resize (solution->size());
 
   solution->localize (global_soln);
 }

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

Definition at line 744 of file system.C.

References libMesh::System::solution.

 {
   parallel_object_only();
 
   global_soln.resize        (solution->size());
 
   solution->localize_to_one (global_soln, dest_proc);
 }

◆ user_assembly()

void libMesh::System::user_assembly ( )

virtualinherited

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

Definition at line 2109 of file system.C.

References libMesh::System::_assemble_system_function, libMesh::System::_assemble_system_object, libMesh::System::_equation_systems, libMesh::System::Assembly::assemble(), and libMesh::System::name().

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

 {
   // Call the user-provided assembly function,
   // if it was provided
   if (_assemble_system_function != nullptr)
     this->_assemble_system_function (_equation_systems, this->name());
 
   // ...or the user-provided assembly object.
   else if (_assemble_system_object != nullptr)
     this->_assemble_system_object->assemble();
 }

◆ user_constrain()

void libMesh::System::user_constrain ( )

virtualinherited

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

Definition at line 2123 of file system.C.

References libMesh::System::_constrain_system_function, libMesh::System::_constrain_system_object, libMesh::System::_equation_systems, libMesh::System::Constraint::constrain(), and libMesh::System::name().

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

 {
   // Call the user-provided constraint function,
   // if it was provided
   if (_constrain_system_function!= nullptr)
     this->_constrain_system_function(_equation_systems, this->name());
 
   // ...or the user-provided constraint object.
   else if (_constrain_system_object != nullptr)
     this->_constrain_system_object->constrain();
 }

◆ user_initialization()

void libMesh::System::user_initialization ( )

virtualinherited

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

Definition at line 2095 of file system.C.

References libMesh::System::_equation_systems, libMesh::System::_init_system_function, libMesh::System::_init_system_object, libMesh::System::Initialization::initialize(), and libMesh::System::name().

Referenced by libMesh::NewmarkSystem::initial_conditions(), and libMesh::System::reinit_mesh().

 {
   // Call the user-provided initialization function,
   // if it was provided
   if (_init_system_function != nullptr)
     this->_init_system_function (_equation_systems, this->name());
 
   // ...or the user-provided initialization object.
   else if (_init_system_object != nullptr)
     this->_init_system_object->initialize();
 }

◆ user_QOI()

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.

Definition at line 2137 of file system.C.

References libMesh::System::_equation_systems, libMesh::System::_qoi_evaluate_function, libMesh::System::_qoi_evaluate_object, libMesh::System::name(), and libMesh::System::QOI::qoi().

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

 {
   // Call the user-provided quantity of interest function,
   // if it was provided
   if (_qoi_evaluate_function != nullptr)
     this->_qoi_evaluate_function(_equation_systems, this->name(), qoi_indices);
 
   // ...or the user-provided QOI function object.
   else if (_qoi_evaluate_object != nullptr)
     this->_qoi_evaluate_object->qoi(qoi_indices);
 }

◆ user_QOI_derivative()

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.

Definition at line 2151 of file system.C.

References libMesh::System::_equation_systems, libMesh::System::_qoi_evaluate_derivative_function, libMesh::System::_qoi_evaluate_derivative_object, libMesh::System::name(), and libMesh::System::QOIDerivative::qoi_derivative().

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

 {
   // Call the user-provided quantity of interest derivative,
   // if it was provided
   if (_qoi_evaluate_derivative_function != nullptr)
     this->_qoi_evaluate_derivative_function
       (_equation_systems, this->name(), qoi_indices, include_liftfunc,
        apply_constraints);
 
   // ...or the user-provided QOI derivative function object.
   else if (_qoi_evaluate_derivative_object != nullptr)
     this->_qoi_evaluate_derivative_object->qoi_derivative
       (qoi_indices, include_liftfunc, apply_constraints);
 }

◆ variable()

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

inherited

Return a constant reference to Variable var.

Definition at line 2704 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable().

 {
   return this->get_dof_map().variable(i);
 }

◆ variable_group()

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

inherited

Return a constant reference to VariableGroup vg.

Definition at line 2709 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable_group().

Referenced by libMesh::FEMSystem::assembly(), and libMesh::System::get_info().

 {
   return this->get_dof_map().variable_group(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 2679 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable_name().

Referenced by libMesh::PetscDMWrapper::build_section(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::ExactSolution::ExactSolution(), libMesh::EquationSystems::find_variable_numbers(), main(), output_norms(), libMesh::petsc_auto_fieldsplit(), libMesh::InterMeshProjection::project_system_vectors(), MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData(), libMesh::System::write_header(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

 {
   return this->get_dof_map().variable_name(i);
 }

◆ variable_number()

unsigned int libMesh::System::variable_number ( std::string_view var ) const

inherited

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

Definition at line 1398 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable_number().

Referenced by libMesh::ExactSolution::_compute_error(), alternative_fe_assembly(), LinearElasticity::assemble(), AssembleOptimization::assemble_A_and_F(), assemble_divgrad(), assemble_elasticity(), assemble_graddiv(), assemble_matrix_and_rhs(), assemble_shell(), assemble_stokes(), compute_enriched_soln(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::ExactErrorEstimator::estimate_error(), fe_assembly(), libMesh::ExactErrorEstimator::find_squared_element_error(), CoupledSystemQoI::init_context(), libMesh::HDGProblem::jacobian(), LargeDeformationElasticity::jacobian(), line_print(), main(), LinearElasticityWithContact::move_mesh(), libMesh::System::read_header(), libMesh::HDGProblem::residual(), LargeDeformationElasticity::residual(), LinearElasticityWithContact::residual_and_jacobian(), OverlappingAlgebraicGhostingTest::run_ghosting_test(), OverlappingCouplingGhostingTest::run_sparsity_pattern_test(), OverlappingTestBase::setup_coupling_matrix(), libMesh::DTKAdapter::update_variable_values(), libMesh::System::variable_scalar_number(), libMesh::EnsightIO::write_scalar_ascii(), and libMesh::EnsightIO::write_vector_ascii().

 {
   return this->get_dof_map().variable_number(var);
 }

◆ variable_scalar_number() [1/2]

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

inlineinherited

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 2474 of file system.h.

References libMesh::System::variable_number().

Referenced by libMesh::Nemesis_IO::copy_scalar_solution(), libMesh::ExodusII_IO::copy_scalar_solution(), libMesh::ExactErrorEstimator::find_squared_element_error(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), and libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()().

 {
   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 2715 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable_scalar_number().

 {
   return this->get_dof_map().variable_scalar_number(var_num, 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 2721 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable_type().

Referenced by libMesh::ExactSolution::_compute_error(), alternative_fe_assembly(), assemble(), libMesh::ClawSystem::assemble_advection_matrices(), libMesh::ClawSystem::assemble_avg_coupling_matrices(), libMesh::ClawSystem::assemble_boundary_condition_matrices(), assemble_ellipticdg(), libMesh::ClawSystem::assemble_jump_coupling_matrix(), libMesh::ClawSystem::assemble_mass_matrix(), assemble_shell(), assemble_stokes(), libMesh::FEMContext::attach_quadrature_rules(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::DGFEMContext::DGFEMContext(), fe_assembly(), libMesh::FEMContext::find_hardest_fe_type(), libMesh::EquationSystems::find_variable_numbers(), form_functionA(), form_functionB(), form_matrixA(), libMesh::FEMSystem::init_context(), libMesh::FEMContext::init_internal_data(), RationalMapTest< elem_type >::setUp(), FETestBase< order, family, elem_type, N_x >::setUp(), EquationSystemsTest::testBadVarNames(), libMesh::Nemesis_IO_Helper::write_element_values(), libMesh::System::write_header(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), libMesh::EnsightIO::write_scalar_ascii(), and libMesh::EnsightIO::write_vector_ascii().

 {
   return this->get_dof_map().variable_type(i);
 }

◆ variable_type() [2/2]

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

inherited

Returns: The finite element type for variable var.

Definition at line 2726 of file system.C.

References libMesh::System::get_dof_map(), and libMesh::DofMap::variable_type().

 {
   return this->get_dof_map().variable_type(var);
 }

◆ vector_is_adjoint()

int libMesh::System::vector_is_adjoint ( std::string_view 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.

Definition at line 1160 of file system.C.

References libMesh::System::_vector_is_adjoint, and libMesh::libmesh_assert().

Referenced by libMesh::InterMeshProjection::project_system_vectors(), and libMesh::System::restrict_vectors().

 {
   const auto it = _vector_is_adjoint.find(vec_name);
   libmesh_assert(it != _vector_is_adjoint.end());
   return it->second;
 }

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

Definition at line 971 of file system.C.

References libMesh::System::_vectors, and libMesh::System::vectors_begin().

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and main().

 {
   // If we don't have that many vectors, throw an error
   libmesh_assert_less(vec_num, _vectors.size());
 
   // Otherwise return a reference to the vec_num'th vector name
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return it->first;
 }

◆ 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

Definition at line 982 of file system.C.

References libMesh::System::_vectors, libMesh::NumericVector< T >::get(), libMesh::libmesh_assert(), libMesh::System::vectors_begin(), and libMesh::System::vectors_end().

 {
   // Linear search for a vector whose pointer matches vec_reference
   auto it = std::find_if(vectors_begin(), vectors_end(),
                          [&vec_reference](const decltype(_vectors)::value_type & pr)
                          { return &vec_reference == pr.second.get(); });
 
   // Before returning, make sure we didn't loop till the end and not find any match
   libmesh_assert (it != vectors_end());
 
   // Return the string associated with the current vector
   return it->first;
 }

◆ vector_preservation()

bool libMesh::System::vector_preservation ( std::string_view vec_name ) const

inherited

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

Definition at line 1135 of file system.C.

References libMesh::System::_vector_projections.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::MemoryHistoryData::store_vectors(), SystemsTest::testAddVectorProjChange(), SystemsTest::testAddVectorTypeChange(), and SystemsTest::testPostInitAddVectorTypeChange().

 {
   if (auto it = _vector_projections.find(vec_name);
       it != _vector_projections.end())
     return it->second;
 
   // vec_name was not in the map, return false
   return false;
 }

◆ vectors_begin() [1/2]

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

inlineinherited

Beginning of vectors container.

Definition at line 2505 of file system.h.

References libMesh::System::_vectors.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::System::get_vector(), libMesh::InterMeshProjection::project_system_vectors(), libMesh::System::request_vector(), libMesh::MemoryHistoryData::store_vectors(), and libMesh::System::vector_name().

 {
   return _vectors.begin();
 }

◆ vectors_begin() [2/2]

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

inlineinherited

Beginning of vectors container.

Definition at line 2511 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.begin();
 }

◆ vectors_end() [1/2]

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

inlineinherited

End of vectors container.

Definition at line 2517 of file system.h.

References libMesh::System::_vectors.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::InterMeshProjection::project_system_vectors(), libMesh::MemoryHistoryData::store_vectors(), and libMesh::System::vector_name().

 {
   return _vectors.end();
 }

◆ vectors_end() [2/2]

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

inlineinherited

End of vectors container.

Definition at line 2523 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()`
	)

inlinevirtualinherited

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

inlinevirtualinherited

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 2578 of file system.h.

 {
   libmesh_not_implemented();
 }

◆ write_header()

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

inherited

Writes the basic data header for this System.

This method implements the output of a System object, embedded in the output of an EquationSystems<T_sys>. This warrants some documentation. The output of this part consists of 5 sections:

for this system

5.) The number of variables in the system (unsigned int)

for each variable in the system

6.) The name of the variable (string)

6.1.) subdomain where the variable lives

7.) Combined in an FEType:

The approximation order(s) of the variable (Order Enum, cast to int/s)
The finite element family/ies of the variable (FEFamily Enum, cast to int/s)

end variable loop

8.) The number of additional vectors (unsigned int),

for each additional vector in the system object

9.) the name of the additional vector (string)

end system

Definition at line 1120 of file system_io.C.

References libMesh::System::_vector_projections, libMesh::System::_vectors, libMesh::Variable::active_subdomains(), libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_mesh(), libMesh::FEType::inf_map, libMesh::libmesh_assert(), libMesh::make_range(), libMesh::System::n_vars(), libMesh::System::n_vectors(), libMesh::System::name(), libMesh::FEType::order, libMesh::ParallelObject::processor_id(), libMesh::FEType::radial_family, libMesh::FEType::radial_order, libMesh::System::variable(), libMesh::System::variable_name(), libMesh::System::variable_type(), and libMesh::Xdr::writing().

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

 {
   libmesh_assert (io.writing());
 
 
   // Only write the header information
   // if we are processor 0.
   if (this->get_mesh().processor_id() != 0)
     return;
 
   std::string comment;
 
   // 5.)
   // Write the number of variables in the system
 
   {
     // set up the comment
     comment = "# No. of Variables in System \"";
     comment += this->name();
     comment += "\"";
 
     unsigned int nv = this->n_vars();
     io.data (nv, comment);
   }
 
 
   for (auto var : make_range(this->n_vars()))
     {
       // 6.)
       // Write the name of the var-th variable
       {
         // set up the comment
         comment  = "#   Name, Variable No. ";
         comment += std::to_string(var);
         comment += ", System \"";
         comment += this->name();
         comment += "\"";
 
         std::string var_name = this->variable_name(var);
         io.data (var_name, comment);
       }
 
       // 6.1.) Variable subdomains
       {
         // set up the comment
         comment  = "#     Subdomains, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         const std::set<subdomain_id_type> & domains = this->variable(var).active_subdomains();
         std::vector<subdomain_id_type> domain_array;
         domain_array.assign(domains.begin(), domains.end());
         io.data (domain_array, comment);
       }
 
       // 7.)
       // Write the approximation order of the var-th variable
       // in this system
       {
         // set up the comment
         comment = "#     Approximation Order, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int order = static_cast<int>(this->variable_type(var).order);
         io.data (order, comment);
       }
 
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
 
       // do the same for radial_order
       {
         comment = "#     Radial Approximation Order, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int rad_order = static_cast<int>(this->variable_type(var).radial_order);
         io.data (rad_order, comment);
       }
 
 #endif
 
       // Write the Finite Element type of the var-th variable
       // in this System
       {
         // set up the comment
         comment = "#     FE Family, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         const FEType & type = this->variable_type(var);
         int fam = static_cast<int>(type.family);
         io.data (fam, comment);
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
 
         comment = "#     Radial FE Family, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int radial_fam = static_cast<int>(type.radial_family);
         io.data (radial_fam, comment);
 
         comment = "#     Infinite Mapping Type, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int i_map = static_cast<int>(type.inf_map);
         io.data (i_map, comment);
 #endif
       }
     } // end of the variable loop
 
   // 8.)
   // Write the number of additional vectors in the System.
   // If write_additional_data==false, then write zero for
   // the number of additional vectors.
   {
     {
       // set up the comment
       comment = "# No. of Additional Vectors, System \"";
       comment += this->name();
       comment += "\"";
 
       unsigned int nvecs = write_additional_data ? this->n_vectors () : 0;
       io.data (nvecs, comment);
     }
 
     if (write_additional_data)
       {
         unsigned int cnt=0;
         for (const auto & [vec_name, vec] : _vectors)
           {
             // 9.)
             // write the name of the cnt-th additional vector
             const std::string dth_vector = std::to_string(cnt++)+"th vector";
             comment =  "# Name of " + dth_vector;
             std::string nonconst_vec_name = vec_name; // Stupid XDR API
 
             io.data (nonconst_vec_name, comment);
             int vec_projection = _vector_projections.at(vec_name);
             comment = "# Whether to do projections for " + dth_vector;
             io.data (vec_projection, comment);
             int vec_type = vec->type();
             comment = "# Parallel type of " + dth_vector;
             io.data (vec_type, comment);
           }
       }
   }
 }

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

This method implements the output of the vectors contained in this System object, embedded in the output of an EquationSystems<T_sys>.

9.) The global solution vector, re-ordered to be node-major (More on this later.)

for each additional vector in the object

10.) The global additional vector, re-ordered to be node-major (More on this later.)

Note that the actual IO is handled through the Xdr class (to be renamed later?) which provides a uniform interface to both the XDR (eXternal Data Representation) interface and standard ASCII output. Thus this one section of code will read XDR or ASCII files with no changes.

Definition at line 1321 of file system_io.C.

References libMesh::System::_vectors, libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::DofObject::invalid_id, libMesh::libmesh_assert(), libMesh::make_range(), libMesh::ParallelObject::n_processors(), libMesh::System::n_vars(), libMesh::System::name(), libMesh::System::number(), libMesh::ParallelObject::processor_id(), libMesh::SCALAR, libMesh::DofMap::SCALAR_dof_indices(), libMesh::System::solution, libMesh::Variable::type(), libMesh::System::variable(), and libMesh::Xdr::writing().

 {
   // PerfLog pl("IO Performance",false);
   // pl.push("write_parallel_data");
   // std::size_t total_written_size = 0;
 
   std::string comment;
 
   libmesh_assert (io.writing());
 
   std::vector<Number> io_buffer; io_buffer.reserve(this->solution->local_size());
 
   // build the ordered nodes and element maps.
   // when writing/reading parallel files we need to iterate
   // over our nodes/elements in order of increasing global id().
   // however, this is not guaranteed to be ordering we obtain
   // by using the node_iterators/element_iterators directly.
   // so build a set, sorted by id(), that provides the ordering.
   // further, for memory economy build the set but then transfer
   // its contents to vectors, which will be sorted.
   std::vector<const DofObject *> ordered_nodes, ordered_elements;
   {
     std::set<const DofObject *, CompareDofObjectsByID>
       ordered_nodes_set (this->get_mesh().local_nodes_begin(),
                          this->get_mesh().local_nodes_end());
 
     ordered_nodes.insert(ordered_nodes.end(),
                          ordered_nodes_set.begin(),
                          ordered_nodes_set.end());
   }
   {
     std::set<const DofObject *, CompareDofObjectsByID>
       ordered_elements_set (this->get_mesh().local_elements_begin(),
                             this->get_mesh().local_elements_end());
 
     ordered_elements.insert(ordered_elements.end(),
                             ordered_elements_set.begin(),
                             ordered_elements_set.end());
   }
 
   const unsigned int sys_num = this->number();
   const unsigned int nv      = this->n_vars();
 
   // Loop over each non-SCALAR variable and each node, and write out the value.
   for (unsigned int var=0; var<nv; var++)
     if (this->variable(var).type().family != SCALAR)
       {
         // First write the node DOF values
         for (const auto & node : ordered_nodes)
           for (auto comp : make_range(node->n_comp(sys_num,var)))
             {
               libmesh_assert_not_equal_to (node->dof_number(sys_num, var, comp),
                                            DofObject::invalid_id);
 
               io_buffer.push_back((*this->solution)(node->dof_number(sys_num, var, comp)));
             }
 
         // Then write the element DOF values
         for (const auto & elem : ordered_elements)
           for (auto comp : make_range(elem->n_comp(sys_num,var)))
             {
               libmesh_assert_not_equal_to (elem->dof_number(sys_num, var, comp),
                                            DofObject::invalid_id);
 
               io_buffer.push_back((*this->solution)(elem->dof_number(sys_num, var, comp)));
             }
       }
 
   // Finally, write the SCALAR data on the last processor
   for (auto var : make_range(this->n_vars()))
     if (this->variable(var).type().family == SCALAR)
       {
         if (this->processor_id() == (this->n_processors()-1))
           {
             const DofMap & dof_map = this->get_dof_map();
             std::vector<dof_id_type> SCALAR_dofs;
             dof_map.SCALAR_dof_indices(SCALAR_dofs, var);
 
             for (auto dof : SCALAR_dofs)
               io_buffer.push_back((*this->solution)(dof));
           }
       }
 
   // 9.)
   //
   // Actually write the reordered solution vector
   // for the ith system to disk
 
   // set up the comment
   {
     comment = "# System \"";
     comment += this->name();
     comment += "\" Solution Vector";
   }
 
   io.data (io_buffer, comment);
 
   // total_written_size += io_buffer.size();
 
   // Only write additional vectors if wanted
   if (write_additional_data)
     {
       for (auto & [vec_name, vec] : _vectors)
         {
           io_buffer.clear();
           io_buffer.reserve(vec->local_size());
 
           // Loop over each non-SCALAR variable and each node, and write out the value.
           for (unsigned int var=0; var<nv; var++)
             if (this->variable(var).type().family != SCALAR)
               {
                 // First write the node DOF values
                 for (const auto & node : ordered_nodes)
                   for (auto comp : make_range(node->n_comp(sys_num,var)))
                     {
                       libmesh_assert_not_equal_to (node->dof_number(sys_num, var, comp),
                                                    DofObject::invalid_id);
 
                       io_buffer.push_back((*vec)(node->dof_number(sys_num, var, comp)));
                     }
 
                 // Then write the element DOF values
                 for (const auto & elem : ordered_elements)
                   for (auto comp : make_range(elem->n_comp(sys_num,var)))
                     {
                       libmesh_assert_not_equal_to (elem->dof_number(sys_num, var, comp),
                                                    DofObject::invalid_id);
 
                       io_buffer.push_back((*vec)(elem->dof_number(sys_num, var, comp)));
                     }
               }
 
           // Finally, write the SCALAR data on the last processor
           for (auto var : make_range(this->n_vars()))
             if (this->variable(var).type().family == SCALAR)
               {
                 if (this->processor_id() == (this->n_processors()-1))
                   {
                     const DofMap & dof_map = this->get_dof_map();
                     std::vector<dof_id_type> SCALAR_dofs;
                     dof_map.SCALAR_dof_indices(SCALAR_dofs, var);
 
                     for (auto dof : SCALAR_dofs)
                       io_buffer.push_back((*vec)(dof));
                   }
               }
 
           // 10.)
           //
           // Actually write the reordered additional vector
           // for this system to disk
 
           // set up the comment
           {
             comment = "# System \"";
             comment += this->name();
             comment += "\" Additional Vector \"";
             comment += vec_name;
             comment += "\"";
           }
 
           io.data (io_buffer, comment);
 
           // total_written_size += io_buffer.size();
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_written_size*sizeof(Number)/dt;
 
   // libMesh::err << "Write " << total_written_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("write_parallel_data");
 }

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

Definition at line 185 of file rb_parametrized.C.

References libMesh::RBParametrized::write_discrete_parameter_values_to_file(), and libMesh::RBParametrized::write_parameter_ranges_to_file().

Referenced by libMesh::RBSCMEvaluation::legacy_write_offline_data_to_files(), and libMesh::RBEvaluation::legacy_write_offline_data_to_files().

 {
   write_parameter_ranges_to_file(continuous_param_file_name, write_binary_data);
   write_discrete_parameter_values_to_file(discrete_param_file_name, write_binary_data);
 }

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

This method implements the output of the vectors contained in this System object, embedded in the output of an EquationSystems<T_sys>.

9.) The global solution vector, re-ordered to be node-major (More on this later.)

for each additional vector in the object

10.) The global additional vector, re-ordered to be node-major (More on this later.)

Definition at line 1521 of file system_io.C.

References libMesh::System::_vectors, libMesh::Xdr::comment(), libMesh::System::name(), libMesh::ParallelObject::processor_id(), libMesh::System::solution, and libMesh::System::write_serialized_vector().

Referenced by libMesh::TransientRBConstruction::write_riesz_representors_to_files(), and libMesh::RBConstruction::write_riesz_representors_to_files().

 {
   parallel_object_only();
   std::string comment;
 
   // PerfLog pl("IO Performance",false);
   // pl.push("write_serialized_data");
   // std::size_t total_written_size = 0;
 
   // total_written_size +=
   this->write_serialized_vector(io, *this->solution);
 
   // set up the comment
   if (this->processor_id() == 0)
     {
       comment = "# System \"";
       comment += this->name();
       comment += "\" Solution Vector";
 
       io.comment (comment);
     }
 
   // Only write additional vectors if wanted
   if (write_additional_data)
     {
       for (auto & pair : this->_vectors)
         {
           // total_written_size +=
           this->write_serialized_vector(io, *pair.second);
 
           // set up the comment
           if (this->processor_id() == 0)
             {
               comment = "# System \"";
               comment += this->name();
               comment += "\" Additional Vector \"";
               comment += pair.first;
               comment += "\"";
               io.comment (comment);
             }
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_written_size*sizeof(Number)/dt;
 
   // libMesh::out << "Write " << total_written_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("write_serialized_data");
 
 
 
 
   // // test the new method
   // {
   //   std::vector<std::string> names;
   //   std::vector<NumericVector<Number> *> vectors_to_write;
 
   //   names.push_back("Solution Vector");
   //   vectors_to_write.push_back(this->solution.get());
 
   //   // Only write additional vectors if wanted
   //   if (write_additional_data)
   //     {
   // std::map<std::string, NumericVector<Number> *>::const_iterator
   //   pos = _vectors.begin();
 
   // for (; pos != this->_vectors.end(); ++pos)
   //   {
   //     names.push_back("Additional Vector " + pos->first);
   //     vectors_to_write.push_back(pos->second);
   //   }
   //     }
 
   //   total_written_size =
   //     this->write_serialized_vectors (io, names, vectors_to_write);
 
   //   const Real
   //     dt2   = pl.get_elapsed_time(),
   //     rate2 = total_written_size*sizeof(Number)/(dt2-dt);
 
   //   libMesh::out << "Write (new) " << total_written_size << " \"Number\" values\n"
   //       << " Elapsed time = " << (dt2-dt) << '\n'
   //       << " Rate = " << rate2/1.e6 << "(MB/sec)\n\n";
 
   // }
 }

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

Definition at line 2114 of file system_io.C.

References libMesh::Xdr::data(), libMesh::System::get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshTools::n_elem(), libMesh::MeshBase::n_elem(), n_nodes, libMesh::MeshBase::n_nodes(), libMesh::System::n_vars(), libMesh::ParallelObject::processor_id(), libMesh::SCALAR, libMesh::System::variable(), libMesh::System::write_SCALAR_dofs(), libMesh::System::write_serialized_blocked_dof_objects(), and libMesh::Xdr::writing().

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

 {
   parallel_object_only();
 
   libmesh_assert (io.writing());
 
   // Cache these - they are not free!
   const dof_id_type
     n_nodes       = this->get_mesh().n_nodes(),
     n_elem        = this->get_mesh().n_elem();
 
   std::size_t written_length = 0;
 
   if (this->processor_id() == 0)
     {
       unsigned int
         n_vec    = cast_int<unsigned int>(vectors.size());
       dof_id_type
         vec_size = vectors.empty() ? 0 : vectors[0]->size();
       // Set the number of vectors
       io.data(n_vec, "# number of vectors");
       // Set the buffer size
       io.data(vec_size, "# vector length");
     }
 
   //---------------------------------
   // Collect the values for all nodes
   written_length +=
     this->write_serialized_blocked_dof_objects (vectors,
                                                 n_nodes,
                                                 this->get_mesh().local_nodes_begin(),
                                                 this->get_mesh().local_nodes_end(),
                                                 io);
 
   //------------------------------------
   // Collect the values for all elements
   written_length +=
     this->write_serialized_blocked_dof_objects (vectors,
                                                 n_elem,
                                                 this->get_mesh().local_elements_begin(),
                                                 this->get_mesh().local_elements_end(),
                                                 io);
 
   //-------------------------------------------
   // Finally loop over all the SCALAR variables
   for (const NumericVector<Number> * vec : vectors)
     for (auto var : make_range(this->n_vars()))
       if (this->variable(var).type().family == SCALAR)
         {
           libmesh_assert_not_equal_to (vec, 0);
 
           written_length +=
             this->write_SCALAR_dofs (*vec, var, io);
         }
 
   return written_length;
 }

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

Definition at line 1450 of file system.C.

References libMesh::System::get_mesh(), mesh, libMesh::System::n_vars(), libMesh::System::number(), libMesh::Threads::parallel_for(), and libMesh::NumericVector< T >::set().

 {
   /* Make sure the call makes sense.  */
   libmesh_assert_less (var_num, this->n_vars());
 
   /* Get a reference to the mesh.  */
   const MeshBase & mesh = this->get_mesh();
 
   /* Check which system we are.  */
   const unsigned int sys_num = this->number();
 
   // Loop over nodes.
   for (const auto & node : mesh.local_node_ptr_range())
     {
       unsigned int n_comp = node->n_comp(sys_num,var_num);
       for (unsigned int i=0; i<n_comp; i++)
         {
           const dof_id_type index = node->dof_number(sys_num,var_num,i);
           v.set(index,0.0);
         }
     }
 
   // Loop over elements.
   Threads::parallel_for
     (mesh.active_local_element_stored_range(),
      [sys_num, var_num, &v](const ConstElemRange & range)
      {
        for (const Elem * elem : range)
          {
            unsigned int n_comp = elem->n_comp(sys_num,var_num);
            for (unsigned int i=0; i<n_comp; i++)
              {
                const dof_id_type index = elem->dof_number(sys_num,var_num,i);
                v.set(index,0.0);
              }
          }
      });
 }

Member Data Documentation

◆ _communicator

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

protectedinherited

Definition at line 120 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::StaticCondensation::close(), libMesh::ParallelObject::comm(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), libMesh::ParallelObject::processor_id(), libMesh::BoundaryInfo::regenerate_id_sets(), libMesh::StaticCondensationDofMap::reinit(), and libMesh::BoundaryInfo::synchronize_global_id_set().

◆ _counts [1/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

◆ _counts [2/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

◆ _enable_print_counter [1/2]

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

Definition at line 143 of file reference_counter.h.

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

◆ _enable_print_counter [2/2]

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

Definition at line 143 of file reference_counter.h.

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

◆ _mutex [1/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 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 137 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 132 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 132 of file reference_counter.h.

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

◆ _normalize_solution_snapshots

bool libMesh::RBConstructionBase< System >::_normalize_solution_snapshots

protectedinherited

Set this boolean to true if we want to normalize solution snapshots used in training to have norm of 1.

This is relevant if snapshots have differing magnitudes and we want to approximate them all with equal accuracy.

Definition at line 281 of file rb_construction_base.h.

Referenced by libMesh::RBEIMConstruction::train_eim_approximation().

◆ 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 1609 of file system.h.

Referenced by libMesh::ImplicitSystem::adjoint_solve(), libMesh::ClawSystem::ClawSystem(), libMesh::ImplicitSystem::disable_cache(), libMesh::System::disable_cache(), main(), libMesh::RBConstruction::RBConstruction(), libMesh::RBSCMConstruction::RBSCMConstruction(), libMesh::ImplicitSystem::sensitivity_solve(), libMesh::EigenSystem::solve(), libMesh::CondensedEigenSystem::solve(), and libMesh::LinearImplicitSystem::solve().

◆ best_fit_type_flag

BEST_FIT_TYPE libMesh::RBEIMConstruction::best_fit_type_flag

inherited

Enum that indicates which type of "best fit" algorithm we should use.

a) projection: Find the best fit in the inner product b) eim: Use empirical interpolation to find a "best fit"

Definition at line 302 of file rb_eim_construction.h.

Referenced by libMesh::RBEIMConstruction::compute_max_eim_error(), libMesh::RBEIMConstruction::print_info(), libMesh::RBEIMConstruction::set_best_fit_type_flag(), libMesh::RBEIMConstruction::train_eim_approximation(), and libMesh::RBEIMConstruction::train_eim_approximation_with_greedy().

◆ 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 1667 of file 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 1640 of file system.h.

Referenced by CurlCurlSystem::init_data(), and set_system_parameters().

◆ inner_product_storage_vector

std::unique_ptr<NumericVector<Number> > libMesh::RBConstructionBase< System >::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 288 of file rb_construction_base.h.

◆ parameters

Parameters libMesh::System::parameters

inherited

Parameters for the system. If a parameter is not provided, it should be retrieved from the EquationSystems.

Definition at line 1588 of file system.h.

Referenced by libMesh::ImplicitSystem::get_linear_solve_parameters(), libMesh::FrequencySystem::init_data(), libMesh::NonlinearImplicitSystem::set_solver_parameters(), libMesh::EigenSystem::solve(), libMesh::CondensedEigenSystem::solve(), and libMesh::EigenSystem::solve_helper().

◆ quiet_mode

bool libMesh::RBConstructionBase< System >::quiet_mode

protectedinherited

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

Definition at line 265 of file rb_construction_base.h.

Referenced by libMesh::RBEIMConstruction::process_parameters_file().

◆ serial_training_set

bool libMesh::RBConstructionBase< System >::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 273 of file rb_construction_base.h.

Referenced by libMesh::RBEIMConstruction::initialize_parametrized_functions_in_training_set(), and libMesh::RBEIMConstruction::RBEIMConstruction().

◆ solution

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

inherited

Data structure to hold solution values.

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

Referenced by libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubProjector::construct_projection(), HeatSystem::element_qoi(), fill_dirichlet_bc(), libMesh::ExactErrorEstimator::find_squared_element_error(), initialize(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::UnsteadySolver::integrate_adjoint_sensitivity(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), main(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::System::reinit_constraints(), libMesh::UnsteadySolver::retrieve_timestep(), and libMesh::TwostepTimeSolver::solve().

◆ 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 1625 of file system.h.

Referenced by libMesh::EulerSolver::_general_residual(), libMesh::Euler2Solver::_general_residual(), libMesh::SteadySolver::_general_residual(), libMesh::NewmarkSolver::_general_residual(), libMesh::DifferentiableSystem::clear(), libMesh::DiffContext::DiffContext(), and libMesh::FEMContext::pre_fe_reinit().

◆ verbose_mode

bool libMesh::RBParametrized::verbose_mode

inherited

Public boolean to toggle verbose mode.

Definition at line 181 of file rb_parametrized.h.

Referenced by libMesh::RBParametrized::check_if_valid_params().

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

examples/reduced_basis/reduced_basis_ex4/eim_classes.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

Detailed Description

Member Typedef Documentation

◆ const_matrices_iterator

◆ const_vectors_iterator

◆ Counts [1/2]

◆ Counts [2/2]

◆ GradientFunctionPointer

◆ matrices_iterator

◆ NodeDataMap

◆ QpDataMap

◆ SideQpDataMap

◆ sys_type

◆ ValueFunctionPointer

◆ vectors_iterator

Member Enumeration Documentation

◆ BEST_FIT_TYPE

Constructor & Destructor Documentation

◆ SimpleEIMConstruction() [1/2]

◆ SimpleEIMConstruction() [2/2]

Member Function Documentation

◆ activate()

◆ active()

◆ add_adjoint_rhs()

◆ add_adjoint_solution()

◆ add_matrices()

◆ add_matrix() [1/3]

◆ add_matrix() [2/3]

◆ add_matrix() [3/3]

◆ add_sensitivity_rhs()

◆ add_sensitivity_solution()

◆ add_variable() [1/2]

◆ add_variable() [2/2]

◆ add_variable_array()

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

◆ apply_normalization_to_solution_snapshots()

◆ assemble()

◆ assemble_qoi()

◆ assemble_qoi_derivative()

◆ assemble_residual_derivatives()

◆ attach_assemble_function()

◆ attach_assemble_object()

◆ attach_constraint_function()

◆ attach_constraint_object()

◆ attach_init_function()

◆ attach_init_object()

◆ attach_QOI_derivative()

◆ attach_QOI_derivative_object()

◆ attach_QOI_function()

◆ attach_QOI_object()

◆ boundary_project_solution() [1/2]

◆ boundary_project_solution() [2/2]

◆ boundary_project_vector() [1/2]

◆ boundary_project_vector() [2/2]

◆ broadcast_parameters()

◆ build_eim_assembly() [1/2]

◆ build_eim_assembly() [2/2]

◆ calculate_norm() [1/2]

◆ calculate_norm() [2/2]

◆ can_add_matrices()

◆ clear()

◆ comm()

◆ compare()

◆ condense_constrained_dofs()

◆ create_static_condensation()

◆ current_solution()