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

#include <rb_scm_construction.h>

Inheritance diagram for libMesh::RBSCMConstruction:

Public Types
typedef RBSCMConstruction	sys_type
	The type of system.

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

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.

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.

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.

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

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

	RBSCMConstruction (RBSCMConstruction &&)=default
	Special functions.

	RBSCMConstruction (const RBSCMConstruction &)=delete

RBSCMConstruction &	operator= (const RBSCMConstruction &)=delete

RBSCMConstruction &	operator= (RBSCMConstruction &&)=delete

virtual	~RBSCMConstruction ()

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

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

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

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

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

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

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

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

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

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

void	set_SCM_training_tolerance (Real SCM_training_tolerance_in)

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

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

sys_type &	system ()

void	set_quiet_mode (bool quiet_mode_in)
	Set the quiet_mode flag.

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

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

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

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

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

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

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.

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

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

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

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

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.

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

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

dof_id_type	n_global_non_condensed_dofs () const

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

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

bool	has_condensed_matrix_A () const

bool	has_condensed_matrix_B () const

bool	has_condensed_precond_matrix () const

SparseMatrix< Number > &	get_condensed_matrix_A ()

SparseMatrix< Number > &	get_condensed_matrix_B ()

SparseMatrix< Number > &	get_condensed_precond_matrix ()

void	copy_sub_to_super (const NumericVector< Number > &sub, NumericVector< Number > &super)
	Copy a logically sub-vector into a super-vector.

void	copy_super_to_sub (NumericVector< Number > &super, NumericVector< Number > &sub)
	Copy a logically super-vector into a sub-vector.

void	copy_super_to_sub (const SparseMatrix< Number > &super, SparseMatrix< Number > &sub)
	Copy a logically super-matrix into a sub-matrix.

void	dont_create_submatrices_in_solve ()
	Instructs not to create the condensed submatrices from the global matrices right before the solve.

void	initialize_condensed_matrices ()
	Initializes the condensed matrices.

bool	have_condensed_dofs () const

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

virtual std::pair< Real, Real >	get_eigenvalue (dof_id_type i)

virtual std::string	system_type () const override

unsigned int	get_n_converged () const

unsigned int	get_n_iterations () const

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

EigenProblemType	get_eigenproblem_type () const

void	set_initial_space (NumericVector< Number > &initial_space_in)
	Sets an initial eigen vector.

bool	generalized () const

bool	use_shell_matrices () const

void	use_shell_matrices (bool use_shell_matrices)
	Set a flag to use shell matrices.

bool	use_shell_precond_matrix () const

void	use_shell_precond_matrix (bool use_shell_precond_matrix)
	Set a flag to use a shell preconditioning matrix.

const SparseMatrix< Number > &	get_matrix_A () const

SparseMatrix< Number > &	get_matrix_A ()

const SparseMatrix< Number > &	get_matrix_B () const

SparseMatrix< Number > &	get_matrix_B ()

const SparseMatrix< Number > &	get_precond_matrix () const

SparseMatrix< Number > &	get_precond_matrix ()

const ShellMatrix< Number > &	get_shell_matrix_A () const

ShellMatrix< Number > &	get_shell_matrix_A ()

const ShellMatrix< Number > &	get_shell_matrix_B () const

ShellMatrix< Number > &	get_shell_matrix_B ()

const ShellMatrix< Number > &	get_shell_precond_matrix () const

ShellMatrix< Number > &	get_shell_precond_matrix ()

const EigenSolver< Number > &	get_eigen_solver () const

EigenSolver< Number > &	get_eigen_solver ()

bool	has_matrix_A () const

bool	has_matrix_B () const

bool	has_precond_matrix () const

bool	has_shell_matrix_A () const

bool	has_shell_matrix_B () const

bool	has_shell_precond_matrix () const

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

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

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

bool	is_initialized () const

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

virtual void	assemble ()
	Prepares `matrix` and `_dof_map` for matrix assembly.

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

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

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

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.

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

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

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.

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

bool	is_adjoint_already_solved () const
	Accessor for the adjoint_already_solved boolean.

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

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

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

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

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

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

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

const std::string &	name () const

void	project_solution (FunctionBase< Number > f, FunctionBase< Gradient > g=nullptr, 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

void	deactivate ()
	Deactivates the system.

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

vectors_iterator	vectors_begin ()
	Beginning of vectors container.

const_vectors_iterator	vectors_begin () const
	Beginning of vectors container.

vectors_iterator	vectors_end ()
	End of vectors container.

const_vectors_iterator	vectors_end () const
	End of vectors container.

matrices_iterator	matrices_begin ()
	Beginning of matrices container.

const_matrices_iterator	matrices_begin () const
	Beginning of matrices container.

matrices_iterator	matrices_end ()
	End of matrices container.

const_matrices_iterator	matrices_end () const
	End of matrices container.

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.

void	remove_vector (std::string_view vec_name)
	Removes the additional vector `vec_name` from this system.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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

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

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.

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

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

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

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

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

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

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

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.

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

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.

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

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

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

bool	has_constraint_object () const

Constraint &	get_constraint_object ()
	Return the user object for imposing constraints.

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

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

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

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

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

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

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

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.

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.

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

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

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

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

Number	current_solution (const dof_id_type global_dof_number) const

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

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

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.

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.

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

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.

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

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.

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

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.

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

bool	get_project_with_constraints ()
	Setter and getter functions for project_with_constraints boolean.

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.

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.

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

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.

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

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.

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

bool	prefix_with_name () const

std::string	prefix () const

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

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.

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

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

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

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

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

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.

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

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

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

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

void	print_parameters () const
	Print the current parameters.

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.

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.

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

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

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

Static Public Member Functions
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.

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.

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

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

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

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

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

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

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

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

static void	disable_print_counter_info ()

static void	disable_print_counter_info ()

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

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

SparseMatrix< Number > *	matrix_A
	The system matrix for standard eigenvalue problems.

SparseMatrix< Number > *	matrix_B
	A second system matrix for generalized eigenvalue problems.

std::unique_ptr< ShellMatrix< Number > >	shell_matrix_A
	The system shell matrix for standard eigenvalue problems.

std::unique_ptr< ShellMatrix< Number > >	shell_matrix_B
	A second system shell matrix for generalized eigenvalue problems.

SparseMatrix< Number > *	precond_matrix
	A preconditioning matrix.

std::unique_ptr< ShellMatrix< Number > >	shell_precond_matrix
	A preconditioning shell matrix.

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

Parameters	parameters
	Parameters for the system. If a parameter is not provided, it should be retrieved from the EquationSystems.

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

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

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

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

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

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

bool	verbose_mode
	Public boolean to toggle verbose mode.

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

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

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

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

virtual void	compute_SCM_bounding_box ()
	Compute the SCM bounding box.

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

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

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

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

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

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

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

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

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.

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

virtual void	add_matrices () override
	Adds the necessary matrices and shell matrices.

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

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

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

void	solve_helper (SparseMatrix< Number > const A, SparseMatrix< Number > const B, SparseMatrix< Number > *const P)

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.

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.

bool	can_add_matrices () const

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

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

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

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

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.

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

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

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

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

bool	_normalize_solution_snapshots
	Set this boolean to true if we want to normalize solution snapshots used in training to have norm of 1.

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

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data.

static Counts	_counts
	Actually holds the data.

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

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

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

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

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

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

Private Member Functions
virtual bool	condense_constrained_dofs () const override final
	Whether this object should condense out constrained degrees of freedom.

void	late_matrix_init (SparseMatrix< Number > &mat, ParallelType type)
	Helper function to keep DofMap forward declarable in system.h.

Real	discrete_var_norm (const NumericVector< Number > &v, unsigned int var, FEMNormType norm_type) const
	Finds the discrete norm for the entries in the vector corresponding to Dofs associated with var.

template<typename iterator_type , typename InValType >
std::size_t	read_serialized_blocked_dof_objects (const dof_id_type n_objects, const iterator_type begin, const iterator_type end, const InValType dummy, Xdr &io, const std::vector< NumericVector< Number > * > &vecs, const unsigned int var_to_read=libMesh::invalid_uint) const
	Reads an input vector from the stream `io` and assigns the values to a set of `DofObjects`.

unsigned int	read_SCALAR_dofs (const unsigned int var, Xdr &io, NumericVector< Number > *vec) const
	Reads the SCALAR dofs from the stream `io` and assigns the values to the appropriate entries of `vec`.

template<typename InValType >
numeric_index_type	read_serialized_vector (Xdr &io, NumericVector< Number > *vec)
	Reads a vector for this System.

numeric_index_type	read_serialized_vector (Xdr &io, NumericVector< Number > &vec)
	Non-templated version for backward compatibility.

template<typename iterator_type >
std::size_t	write_serialized_blocked_dof_objects (const std::vector< const NumericVector< Number > * > &vecs, const dof_id_type n_objects, const iterator_type begin, const iterator_type end, Xdr &io, const unsigned int var_to_write=libMesh::invalid_uint) const
	Writes an output vector to the stream `io` for a set of `DofObjects`.

unsigned int	write_SCALAR_dofs (const NumericVector< Number > &vec, const unsigned int var, Xdr &io) const
	Writes the SCALAR dofs associated with var to the stream `io`.

dof_id_type	write_serialized_vector (Xdr &io, const NumericVector< Number > &vec) const
	Writes a vector for this System.

void	write_parameter_ranges_to_file (const std::string &file_name, const bool write_binary)
	Write out the parameter ranges to file.

void	write_discrete_parameter_values_to_file (const std::string &file_name, const bool write_binary_data)
	Write out the discrete parameter values to file.

void	read_parameter_ranges_from_file (const std::string &file_name, const bool read_binary, RBParameters &param_min, RBParameters &param_max)
	Read in the parameter ranges from file.

void	read_discrete_parameter_values_from_file (const std::string &file_name, const bool read_binary_data, std::map< std::string, std::vector< Real > > &discrete_parameter_values_in)
	Read in the discrete parameter values from file, if we have any.

bool	check_if_valid_params (const RBParameters &params) const
	Helper function to check that `params` is valid:

Static Private Member Functions
static bool	is_value_in_list (Real value, const std::vector< Real > &list_of_values, Real tol)
	Helper function to check if the specified value is in the list of values (within a tolerance given by `tol`).

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

bool	_training_parameters_initialized
	Boolean flag to indicate whether or not the parameter ranges have been initialized.

std::map< std::string, std::vector< RBParameter > >	_training_parameters
	The training samples for each parameter.

numeric_index_type	_first_local_index
	The first sample-vector index from the global vector which is stored in the _training_parameters on this processor.

numeric_index_type	_n_local_training_samples

numeric_index_type	_n_global_training_samples

int	_training_parameters_random_seed
	If < 0, use std::time() * processor_id() to seed the random number generator for the training parameters (default).

bool	_condensed_dofs_initialized
	A private flag to indicate whether the condensed dofs have been initialized.

bool	_have_condensed_dofs
	Whether there are any condensed degrees of freedom.

bool	_create_submatrices_in_solve
	Denotes whether to create the condensed submatrices from the global matrices in the solve.

std::unique_ptr< SparseMatrix< Number > >	_condensed_matrix_A
	The (condensed) system matrix for standard eigenvalue problems.

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

std::unique_ptr< SparseMatrix< Number > >	_condensed_precond_matrix
	The condensed preconditioning matrix.

unsigned int	_n_converged_eigenpairs
	The number of converged eigenpairs.

unsigned int	_n_iterations
	The number of iterations of the eigen solver algorithm.

EigenProblemType	_eigen_problem_type
	The type of the eigenvalue problem.

bool	_use_shell_matrices
	A boolean flag to indicate whether or not to use shell matrices.

bool	_use_shell_precond_matrix
	A boolean flag to indicate whether or not to use a shell preconditioning matrix.

void(*	_init_system_function )(EquationSystems &es, const std::string &name)
	Function that initializes the system.

Initialization *	_init_system_object
	Object that initializes the system.

void(*	_assemble_system_function )(EquationSystems &es, const std::string &name)
	Function that assembles the system.

Assembly *	_assemble_system_object
	Object that assembles the system.

void(*	_constrain_system_function )(EquationSystems &es, const std::string &name)
	Function to impose constraints.

Constraint *	_constrain_system_object
	Object that constrains the system.

void(*	_qoi_evaluate_function )(EquationSystems &es, const std::string &name, const QoISet &qoi_indices)
	Function to evaluate quantity of interest.

QOI *	_qoi_evaluate_object
	Object to compute quantities of interest.

void(*	_qoi_evaluate_derivative_function )(EquationSystems &es, const std::string &name, const QoISet &qoi_indices, bool include_liftfunc, bool apply_constraints)
	Function to evaluate quantity of interest derivative.

QOIDerivative *	_qoi_evaluate_derivative_object
	Object to compute derivatives of quantities of interest.

std::unique_ptr< DofMap >	_dof_map
	Data structure describing the relationship between nodes, variables, etc... and degrees of freedom.

EquationSystems &	_equation_systems
	Constant reference to the `EquationSystems` object used for the simulation.

MeshBase &	_mesh
	Constant reference to the `mesh` data structure used for the simulation.

const std::string	_sys_name
	A name associated with this system.

const unsigned int	_sys_number
	The number associated with this system.

bool	_active
	Flag stating if the system is active or not.

std::map< std::string, std::unique_ptr< NumericVector< Number > >, std::less<> >	_vectors
	Some systems need an arbitrary number of vectors.

std::map< std::string, bool, std::less<> >	_vector_projections
	Holds true if a vector by that name should be projected onto a changed grid, false if it should be zeroed.

std::map< std::string, int, std::less<> >	_vector_is_adjoint
	Holds non-negative if a vector by that name should be projected using adjoint constraints/BCs, -1 if primal.

std::map< std::string, std::unique_ptr< SparseMatrix< Number > >, std::less<> >	_matrices
	Some systems need an arbitrary number of matrices.

std::map< std::string, ParallelType, std::less<> >	_matrix_types
	Holds the types of the matrices.

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

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

bool	_basic_system_only
	Holds true if the components of more advanced system types (e.g.

bool	_is_initialized
	`true` when additional vectors and variables do not require immediate initialization, `false` otherwise.

unsigned int	_additional_data_written
	This flag is used only when reading in a system from file.

std::vector< unsigned int >	_written_var_indices
	This vector is used only when reading in a system from file.

bool	adjoint_already_solved
	Has the adjoint problem already been solved? If the user sets `adjoint_already_solved` to `true`, we won't waste time solving it again.

bool	_hide_output
	Are we allowed to write this system to file? If `_hide_output` is `true`, then `EquationSystems::write` will ignore this system.

bool	project_with_constraints
	Do we want to apply constraints while projecting vectors ?

bool	_prefer_hash_table_matrix_assembly
	Whether to use hash table matrix assembly if the matrix sub-classes support it.

bool	_require_sparsity_pattern
	Whether any of our matrices require an initial sparsity pattern computation in order to determine preallocation.

bool	_prefix_with_name
	Whether we are name prefixing solver options.

std::vector< Number >	_qoi
	Values of the quantities of interest.

std::vector< Number >	_qoi_error_estimates
	Vector to hold error estimates for qois, either from a steady state calculation, or from a single unsteady solver timestep.

bool	parameters_initialized
	Flag indicating whether the parameters have been initialized.

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

RBParameters	parameters_max

std::map< std::string, std::vector< Real > >	_discrete_parameter_values
	Map that defines the allowable values of any discrete parameters.

Detailed Description

This class is part of the rbOOmit framework.

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

Author: David J. Knezevic

Date: 2009

Definition at line 53 of file rb_scm_construction.h.

Member Typedef Documentation

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

◆ Parent

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

The type of the parent.

Definition at line 84 of file rb_scm_construction.h.

◆ sys_type

typedef RBSCMConstruction libMesh::RBSCMConstruction::sys_type

The type of system.

Definition at line 79 of file rb_scm_construction.h.

◆ ValueFunctionPointer

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

inherited

Projects arbitrary functions onto the current solution.

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

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

Constructor & Destructor Documentation

◆ RBSCMConstruction() [1/3]

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

Constructor.

Optionally initializes required data structures.

Definition at line 47 of file rb_scm_construction.C.

  : Parent(es, name_in, number_in),
    SCM_training_tolerance(0.5),
    RB_system_name(""),
    rb_scm_eval(nullptr)
{
 
  // set assemble_before_solve flag to false
  // so that we control matrix assembly.
  assemble_before_solve = false;
 
  // We symmetrize all operators hence use symmetric solvers
  set_eigenproblem_type(GHEP);
 
}

References libMesh::System::assemble_before_solve, libMesh::GHEP, and libMesh::EigenSystem::set_eigenproblem_type().

◆ RBSCMConstruction() [2/3]

libMesh::RBSCMConstruction::RBSCMConstruction ( RBSCMConstruction && )

default

Special functions.

This class has the same restrictions/defaults as its base class.
Destructor is defaulted out-of-line

◆ RBSCMConstruction() [3/3]

libMesh::RBSCMConstruction::RBSCMConstruction ( const RBSCMConstruction & )

delete

◆ ~RBSCMConstruction()

libMesh::RBSCMConstruction::~RBSCMConstruction ( )

virtualdefault

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.

{
  _active = true;
}

References libMesh::System::_active.

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

{
  return _active;
}

References libMesh::System::_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.

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

References libMesh::System::add_vector().

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

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

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

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

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

◆ add_matrices()

void libMesh::CondensedEigenSystem::add_matrices ( )

overrideprotectedvirtualinherited

Adds the necessary matrices and shell matrices.

Reimplemented from libMesh::EigenSystem.

Definition at line 143 of file condensed_eigen_system.C.

{
  Parent::add_matrices();
 
  if (!this->use_shell_matrices())
  {
    if (!_condensed_matrix_A)
      _condensed_matrix_A = SparseMatrix<Number>::build(this->comm());
    if (!_condensed_matrix_B)
      _condensed_matrix_B = SparseMatrix<Number>::build(this->comm());
 
    // When not using shell matrices we use A for P as well so we don't need to add P
  }
  // we *are* using shell matrices but we might not be using a shell matrix for P
  else if (!this->use_shell_precond_matrix())
  {
    if (!_condensed_precond_matrix)
      _condensed_precond_matrix = SparseMatrix<Number>::build(this->comm());
  }
}

References libMesh::CondensedEigenSystem::_condensed_matrix_A, libMesh::CondensedEigenSystem::_condensed_matrix_B, libMesh::CondensedEigenSystem::_condensed_precond_matrix, libMesh::EigenSystem::add_matrices(), libMesh::SparseMatrix< T >::build(), libMesh::ParallelObject::comm(), libMesh::EigenSystem::use_shell_matrices(), and libMesh::EigenSystem::use_shell_precond_matrix().

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

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

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::System::has_static_condensation(), libMesh::System::late_matrix_init(), and libMesh::libmesh_assert().

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::ImplicitSystem::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().

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

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

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

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

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

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

◆ add_scaled_symm_Aq()

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

protectedvirtual

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

Definition at line 204 of file rb_scm_construction.C.

{
  LOG_SCOPE("add_scaled_symm_Aq()", "RBSCMConstruction");
  // Load the operators from the RBConstruction
  EquationSystems & es = this->get_equation_systems();
  RBConstruction & rb_system = es.get_system<RBConstruction>(RB_system_name);
  rb_system.add_scaled_Aq(scalar, q_a, &get_matrix_A(), true);
}

References libMesh::RBConstruction::add_scaled_Aq(), libMesh::System::get_equation_systems(), libMesh::EigenSystem::get_matrix_A(), libMesh::EquationSystems::get_system(), and RB_system_name.

Referenced by Aq_inner_product(), compute_SCM_bounding_box(), and evaluate_stability_constant().

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

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

References libMesh::System::add_vector().

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

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

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

References libMesh::System::add_vector().

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

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

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

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

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

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

References libMesh::System::add_variable().

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

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

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

Referenced by DofMapTest::testArrayDofIndicesWithType().

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

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

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

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

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

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

References libMesh::System::add_variables().

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

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

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::TimeSolver::init_adjoints(), libMesh::UnsteadySolver::init_adjoints(), libMesh::ContinuationSystem::init_data(), libMesh::OptimizationSystem::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().

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

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

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

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

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

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

References libMesh::System::add_vector().

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

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

{
  libmesh_not_implemented();
}

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

◆ 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::DifferentiableSystem, and libMesh::ImplicitSystem.

Definition at line 2586 of file system.h.

{
  libmesh_not_implemented();
}

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

◆ Aq_inner_product()

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

protected

Compute the inner product between two vectors using matrix Aq.

Definition at line 405 of file rb_scm_construction.C.

{
  libmesh_error_msg_if(q >= get_rb_theta_expansion().get_n_A_terms(),
                       "Error: We must have q < Q_a in Aq_inner_product.");
 
  matrix_A->zero();
  add_scaled_symm_Aq(q, 1.);
  matrix_A->vector_mult(*inner_product_storage_vector, w);
 
  return v.dot(*inner_product_storage_vector);
}

References add_scaled_symm_Aq(), libMesh::NumericVector< T >::dot(), get_rb_theta_expansion(), libMesh::RBConstructionBase< CondensedEigenSystem >::inner_product_storage_vector, libMesh::EigenSystem::matrix_A, libMesh::SparseMatrix< T >::vector_mult(), and libMesh::SparseMatrix< T >::zero().

Referenced by evaluate_stability_constant().

◆ 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::DifferentiableSystem, libMesh::FrequencySystem, libMesh::ImplicitSystem, libMesh::LinearImplicitSystem, and libMesh::NewmarkSystem.

Definition at line 554 of file system.C.

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

References libMesh::System::user_assembly().

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

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

{
  // 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);
}

References libMesh::System::user_QOI().

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

◆ 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::ExplicitSystem, and libMesh::FEMSystem.

Definition at line 576 of file system.C.

{
  // 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);
}

References libMesh::System::user_QOI_derivative().

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

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

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

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

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

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

Referenced by main().

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

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

References fptr(), and libMesh::libmesh_assert().

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

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

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

◆ attach_deflation_space()

virtual void libMesh::RBSCMConstruction::attach_deflation_space ( )

inlinevirtual

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

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

Definition at line 162 of file rb_scm_construction.h.

162{}

Referenced by perform_SCM_greedy().

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

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

References fptr(), and libMesh::libmesh_assert().

Referenced by main(), and main().

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

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

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

References fptr(), and libMesh::libmesh_assert().

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

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

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

References fptr(), and libMesh::libmesh_assert().

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

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

◆ B_inner_product()

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

protected

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

Definition at line 397 of file rb_scm_construction.C.

{
  matrix_B->vector_mult(*inner_product_storage_vector, w);
 
  return v.dot(*inner_product_storage_vector);
}

References libMesh::NumericVector< T >::dot(), libMesh::RBConstructionBase< CondensedEigenSystem >::inner_product_storage_vector, libMesh::EigenSystem::matrix_B, and libMesh::SparseMatrix< T >::vector_mult().

Referenced by evaluate_stability_constant().

◆ 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 1306 of file system_projection.C.

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

References b.

Referenced by SystemsTest::testBoundaryProjectCube().

◆ 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 1287 of file system_projection.C.

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

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

◆ 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 1344 of file system_projection.C.

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

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

◆ 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 1325 of file system_projection.C.

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

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

◆ broadcast_parameters()

void libMesh::RBConstructionBase< CondensedEigenSystem >::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 165 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);
}

◆ calculate_norm() [1/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.

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

References libMesh::FEType::default_quadrature_rule(), dim, libMesh::DISCRETE_L1, libMesh::DISCRETE_L2, libMesh::DISCRETE_L_INF, 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(), libMesh::QBase::n_points(), n_vars, libMesh::Real, libMesh::NumericVector< T >::size(), libMesh::TYPE_SCALAR, libMesh::TYPE_VECTOR, libMesh::W1_INF_SEMINORM, libMesh::W2_INF_SEMINORM, and libMesh::SystemNorm::weight().

◆ calculate_norm() [2/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.

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

References libMesh::DISCRETE_L1, libMesh::DISCRETE_L2, libMesh::DISCRETE_L_INF, libMesh::L2, 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().

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

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

References libMesh::System::_matrices_initialized.

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

◆ check_if_valid_params()

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

privateinherited

Helper function to check that params is valid:

same number of parameters (error)
parameter values are within the min/max range (warning)
discrete values are correctly discrete within tolerance (warning) Warnings are only printed if "verbose_mode" is true.

Definition at line 378 of file rb_parametrized.C.

{
  // Check if number of parameters are correct.
  libmesh_error_msg_if(params.n_parameters() != get_n_params(),
                       "Error: Number of parameters don't match; found "
                       << params.n_parameters() << ", expected "
                       << get_n_params());
 
  bool is_valid = true;
  std::string prev_param_name = "";
  for (const auto & [param_name, sample_vec] : params)
    {
      std::size_t sample_idx = 0;
      const Real & min_value = get_parameter_min(param_name);
      const Real & max_value = get_parameter_max(param_name);
      for (const auto & value_vec : sample_vec)
        {
          for (const auto & value : value_vec)
            {
              // Check every parameter value (including across samples and vector-values)
              // to ensure it's within the min/max range.
              const bool outside_range = ((value < min_value) || (value > max_value));
              is_valid = is_valid && !outside_range;
              if (outside_range && verbose_mode)
                {
                  libMesh::out << "Warning: parameter " << param_name << " value="
                               << value << " outside acceptable range: ("
                               << min_value << ", " << max_value << ")";
                }
 
              // For discrete params, make sure params.get_value(param_name) is sufficiently
              // close to one of the discrete parameter values.
              // Note that vector-values not yet supported in discrete parameters,
              // and the .get_sample_value() call will throw an error if the user
              // tries to do it.
              if (const auto it = get_discrete_parameter_values().find(param_name);
                  it != get_discrete_parameter_values().end())
                {
                  const bool is_value_discrete =
                    is_value_in_list(params.get_sample_value(param_name, sample_idx),
                                     it->second,
                                     TOLERANCE);
                  is_valid = is_valid && is_value_discrete;
                  if (!is_value_discrete && verbose_mode)
                    libMesh::out << "Warning: parameter " << param_name << " value="
                                 << value << " is not in discrete value list.";
                }
            }
          ++sample_idx;
        }
    }
  return is_valid;
}

References libMesh::RBParametrized::get_discrete_parameter_values(), libMesh::RBParametrized::get_n_params(), libMesh::RBParametrized::get_parameter_max(), libMesh::RBParametrized::get_parameter_min(), libMesh::RBParameters::get_sample_value(), libMesh::RBParametrized::is_value_in_list(), libMesh::RBParameters::n_parameters(), libMesh::out, libMesh::Real, libMesh::TOLERANCE, value, and libMesh::RBParametrized::verbose_mode.

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

◆ clear()

void libMesh::RBSCMConstruction::clear ( )

overridevirtual

Clear all the data structures associated with the system.

Reimplemented from libMesh::RBConstructionBase< CondensedEigenSystem >.

Definition at line 67 of file rb_scm_construction.C.

{
  Parent::clear();
}

References libMesh::RBConstructionBase< CondensedEigenSystem >::clear().

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

98 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition parallel_object.h:120

References libMesh::ParallelObject::_communicator.

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

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

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.

◆ compute_SCM_bounding_box()

void libMesh::RBSCMConstruction::compute_SCM_bounding_box ( )

protectedvirtual

Compute the SCM bounding box.

Definition at line 287 of file rb_scm_construction.C.

{
  LOG_SCOPE("compute_SCM_bounding_box()", "RBSCMConstruction");
 
  // Resize the bounding box vectors
  rb_scm_eval->B_min.resize(get_rb_theta_expansion().get_n_A_terms());
  rb_scm_eval->B_max.resize(get_rb_theta_expansion().get_n_A_terms());
 
  for (unsigned int q=0; q<get_rb_theta_expansion().get_n_A_terms(); q++)
    {
      matrix_A->zero();
      add_scaled_symm_Aq(q, 1.);
 
      // Compute B_min(q)
      eigen_solver->set_position_of_spectrum(SMALLEST_REAL);
      set_eigensolver_properties(q);
 
      solve();
      // TODO: Assert convergence for eigensolver
 
      unsigned int nconv = get_n_converged();
      if (nconv != 0)
        {
          std::pair<Real, Real> eval = get_eigenpair(0);
 
          // ensure that the eigenvalue is real
          libmesh_assert_less (eval.second, TOLERANCE);
 
          rb_scm_eval->set_B_min(q, eval.first);
          libMesh::out << std::endl << "B_min("<<q<<") = " << rb_scm_eval->get_B_min(q) << std::endl;
        }
      else
        libmesh_error_msg("Eigen solver for computing B_min did not converge");
 
      // Compute B_max(q)
      eigen_solver->set_position_of_spectrum(LARGEST_REAL);
      set_eigensolver_properties(q);
 
      solve();
      // TODO: Assert convergence for eigensolver
 
      nconv = get_n_converged();
      if (nconv != 0)
        {
          std::pair<Real, Real> eval = get_eigenpair(0);
 
          // ensure that the eigenvalue is real
          libmesh_assert_less (eval.second, TOLERANCE);
 
          rb_scm_eval->set_B_max(q,eval.first);
          libMesh::out << "B_max("<<q<<") = " << rb_scm_eval->get_B_max(q) << std::endl;
        }
      else
        libmesh_error_msg("Eigen solver for computing B_max did not converge");
    }
}

References add_scaled_symm_Aq(), libMesh::RBSCMEvaluation::B_max, libMesh::RBSCMEvaluation::B_min, libMesh::EigenSystem::eigen_solver, libMesh::RBSCMEvaluation::get_B_max(), libMesh::RBSCMEvaluation::get_B_min(), libMesh::CondensedEigenSystem::get_eigenpair(), libMesh::RBThetaExpansion::get_n_A_terms(), libMesh::EigenSystem::get_n_converged(), get_rb_theta_expansion(), libMesh::LARGEST_REAL, libMesh::EigenSystem::matrix_A, libMesh::out, rb_scm_eval, libMesh::RBSCMEvaluation::set_B_max(), libMesh::RBSCMEvaluation::set_B_min(), set_eigensolver_properties(), libMesh::SMALLEST_REAL, libMesh::CondensedEigenSystem::solve(), libMesh::TOLERANCE, and libMesh::SparseMatrix< T >::zero().

Referenced by perform_SCM_greedy().

◆ compute_SCM_bounds_on_training_set()

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

protectedvirtual

Compute upper and lower bounds for each SCM training point.

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

Definition at line 419 of file rb_scm_construction.C.

{
  LOG_SCOPE("compute_SCM_bounds_on_training_set()", "RBSCMConstruction");
 
  // Now compute the maximum bound error over training_parameters
  unsigned int new_C_J_index = 0;
  Real max_SCM_error = 0.;
 
  numeric_index_type first_index = get_first_local_training_index();
  for (unsigned int i=0; i<get_local_n_training_samples(); i++)
    {
      set_params_from_training_set(first_index+i);
      rb_scm_eval->set_parameters( get_parameters() );
      Real LB = rb_scm_eval->get_SCM_LB();
      Real UB = rb_scm_eval->get_SCM_UB();
 
      Real error_i = SCM_greedy_error_indicator(LB, UB);
 
      if (error_i > max_SCM_error)
        {
          max_SCM_error = error_i;
          new_C_J_index = i;
        }
    }
 
  numeric_index_type global_index = first_index + new_C_J_index;
  std::pair<numeric_index_type,Real> error_pair(global_index, max_SCM_error);
  get_global_max_error_pair(this->comm(),error_pair);
 
  return error_pair;
}

References libMesh::ParallelObject::comm(), libMesh::RBConstructionBase< CondensedEigenSystem >::get_first_local_training_index(), libMesh::RBConstructionBase< CondensedEigenSystem >::get_global_max_error_pair(), libMesh::RBConstructionBase< CondensedEigenSystem >::get_local_n_training_samples(), libMesh::RBParametrized::get_parameters(), libMesh::RBSCMEvaluation::get_SCM_LB(), libMesh::RBSCMEvaluation::get_SCM_UB(), rb_scm_eval, libMesh::Real, SCM_greedy_error_indicator(), libMesh::RBParametrized::set_parameters(), and libMesh::RBConstructionBase< CondensedEigenSystem >::set_params_from_training_set().

Referenced by perform_SCM_greedy().

◆ condense_constrained_dofs()

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

inlinefinaloverrideprivatevirtualinherited

Whether this object should condense out constrained degrees of freedom.

Reimplemented from libMesh::System.

Definition at line 196 of file condensed_eigen_system.h.

196{ return true; }

◆ copy_sub_to_super()

void libMesh::CondensedEigenSystem::copy_sub_to_super	(	const NumericVector< Number > &	sub,
		NumericVector< Number > &	super
	)

inherited

Copy a logically sub-vector into a super-vector.

The sub-vector local size should correspond to the size of our local_non_condensed_dofs_vector, e.g. the sub-vector should represent non-condensed degree of freedom. The super should contain both condensed and non-condensed dofs

Definition at line 283 of file condensed_eigen_system.C.

{
  libmesh_assert_equal_to(sub.local_size(), local_non_condensed_dofs_vector.size());
  libmesh_assert_equal_to(sub.local_size() + this->get_dof_map().n_local_constrained_dofs(),
                          super.local_size());
  auto super_sub_view = super.get_subvector(local_non_condensed_dofs_vector);
  *super_sub_view = sub;
  super.restore_subvector(std::move(super_sub_view), local_non_condensed_dofs_vector);
}

References libMesh::NumericVector< T >::get_subvector(), libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector, libMesh::NumericVector< T >::local_size(), and libMesh::NumericVector< T >::restore_subvector().

Referenced by update_current_local_solution().

◆ copy_super_to_sub() [1/2]

void libMesh::CondensedEigenSystem::copy_super_to_sub	(	const SparseMatrix< Number > &	super,
		SparseMatrix< Number > &	sub
	)

inherited

Copy a logically super-matrix into a sub-matrix.

The super matrix should represent all dofs, both condensed and non-condensed. The sub should contain only non-condensed dofs, e.g. its local row ownership size should match the size of our local_non_condensed_dofs_vector

Definition at line 307 of file condensed_eigen_system.C.

{
  parallel_object_only();
 
  libmesh_assert_equal_to(sub.local_m(), local_non_condensed_dofs_vector.size());
  libmesh_assert_equal_to(sub.local_m() + this->get_dof_map().n_local_constrained_dofs(),
                          super.local_m());
  auto super_sub_view = SparseMatrix<Number>::build(super.comm());
  super.create_submatrix(
      *super_sub_view, local_non_condensed_dofs_vector, local_non_condensed_dofs_vector);
  sub = *super_sub_view;
}

References libMesh::SparseMatrix< T >::build(), libMesh::ParallelObject::comm(), libMesh::SparseMatrix< T >::create_submatrix(), libMesh::SparseMatrix< T >::local_m(), and libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector.

◆ copy_super_to_sub() [2/2]

void libMesh::CondensedEigenSystem::copy_super_to_sub	(	NumericVector< Number > &	super,
		NumericVector< Number > &	sub
	)

inherited

Copy a logically super-vector into a sub-vector.

The super vector should represent all dofs, both condensed and non-condensed. The sub should contain only non-condensed dofs, e.g. its local size should match the size of our local_non_condensed_dofs_vector

Definition at line 295 of file condensed_eigen_system.C.

{
  libmesh_assert_equal_to(sub.local_size(), local_non_condensed_dofs_vector.size());
  libmesh_assert_equal_to(sub.local_size() + this->get_dof_map().n_local_constrained_dofs(),
                          super.local_size());
  auto super_sub_view = super.get_subvector(local_non_condensed_dofs_vector);
  sub = *super_sub_view;
  super.restore_subvector(std::move(super_sub_view), local_non_condensed_dofs_vector);
}

References libMesh::NumericVector< T >::get_subvector(), libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector, libMesh::NumericVector< T >::local_size(), and libMesh::NumericVector< T >::restore_subvector().

◆ create_static_condensation()

void libMesh::System::create_static_condensation ( )

virtualinherited

Request that static condensation be performed for this system.

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

Definition at line 2664 of file system.C.

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

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

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

{
  // 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);
}

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(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), LinearElasticityWithContact::compute_stresses(), compute_stresses(), libMesh::ExactErrorEstimator::estimate_error(), main(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::SmoothnessEstimator::EstimateSmoothness::operator()(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::HPCoarsenTest::select_refinement(), SolidSystem::side_time_derivative(), libMesh::EnsightIO::write_scalar_ascii(), and libMesh::EnsightIO::write_vector_ascii().

◆ deactivate()

void libMesh::System::deactivate ( )

inlineinherited

Deactivates the system.

Only active systems are solved.

Definition at line 2449 of file system.h.

{
  _active = false;
}

References libMesh::System::_active.

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

2559{ assemble_before_solve = true; }

References libMesh::System::assemble_before_solve.

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

◆ disable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

◆ disable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

◆ discrete_var_norm()

Real libMesh::System::discrete_var_norm	(	const NumericVector< Number > &	v,
		unsigned int	var,
		FEMNormType	norm_type
	)		const

privateinherited

Finds the discrete norm for the entries in the vector corresponding to Dofs associated with var.

Definition at line 1492 of file system.C.

{
  std::set<dof_id_type> var_indices;
  local_dof_indices(var, var_indices);
 
  if (norm_type == DISCRETE_L1)
    return v.subset_l1_norm(var_indices);
  if (norm_type == DISCRETE_L2)
    return v.subset_l2_norm(var_indices);
  if (norm_type == DISCRETE_L_INF)
    return v.subset_linfty_norm(var_indices);
  else
    libmesh_error_msg("Invalid norm_type = " << Utility::enum_to_string(norm_type));
}

References libMesh::DISCRETE_L1, libMesh::DISCRETE_L2, libMesh::DISCRETE_L_INF, libMesh::Real, libMesh::NumericVector< T >::subset_l1_norm(), libMesh::NumericVector< T >::subset_l2_norm(), and libMesh::NumericVector< T >::subset_linfty_norm().

◆ dont_create_submatrices_in_solve()

void libMesh::CondensedEigenSystem::dont_create_submatrices_in_solve ( )

inlineinherited

Instructs not to create the condensed submatrices from the global matrices right before the solve.

This API should be used when assembly occurs during callbacks during the solve, e.g. for a nonlinear eigen problem, solved with a Newton-based solver to determine the fundamental mode, in which function and matrix evalations are liable to change with every nonlinear iteration. Moreover, calling create_submatrix wipes away callbacks associated with the condensed matrix

Definition at line 169 of file condensed_eigen_system.h.

169{ _create_submatrices_in_solve = false; }

libMesh::CondensedEigenSystem::_create_submatrices_in_solve

bool _create_submatrices_in_solve

Denotes whether to create the condensed submatrices from the global matrices in the solve.

Definition condensed_eigen_system.h:212

References libMesh::CondensedEigenSystem::_create_submatrices_in_solve.

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

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

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

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

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

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

◆ enrich_C_J()

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

protectedvirtual

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

Definition at line 451 of file rb_scm_construction.C.

{
  LOG_SCOPE("enrich_C_J()", "RBSCMConstruction");
 
  set_params_from_training_set_and_broadcast(new_C_J_index);
 
  rb_scm_eval->C_J.push_back(get_parameters());
 
  libMesh::out << std::endl << "SCM: Added mu = (";
 
  bool first = true;
  for (const auto & pr : get_parameters())
    {
      if (!first)
        libMesh::out << ",";
      const std::string & param_name = pr.first;
      RBParameters C_J_params = rb_scm_eval->C_J[rb_scm_eval->C_J.size()-1];
      libMesh::out << C_J_params.get_value(param_name);
      first = false;
    }
  libMesh::out << ")" << std::endl;
 
  // Finally, resize C_J_stability_vector and SCM_UB_vectors
  rb_scm_eval->C_J_stability_vector.push_back(0.);
 
  std::vector<Real> zero_vector(get_rb_theta_expansion().get_n_A_terms());
  rb_scm_eval->SCM_UB_vectors.push_back(zero_vector);
}

References libMesh::RBSCMEvaluation::C_J, libMesh::RBSCMEvaluation::C_J_stability_vector, libMesh::RBParametrized::get_parameters(), get_rb_theta_expansion(), libMesh::RBParameters::get_value(), libMesh::out, rb_scm_eval, libMesh::RBSCMEvaluation::SCM_UB_vectors, and libMesh::RBConstructionBase< CondensedEigenSystem >::set_params_from_training_set_and_broadcast().

Referenced by perform_SCM_greedy().

◆ evaluate_stability_constant()

void libMesh::RBSCMConstruction::evaluate_stability_constant ( )

protectedvirtual

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

Definition at line 344 of file rb_scm_construction.C.

{
  LOG_SCOPE("evaluate_stability_constant()", "RBSCMConstruction");
 
  // Get current index of C_J
  const unsigned int j = cast_int<unsigned int>(rb_scm_eval->C_J.size()-1);
 
  eigen_solver->set_position_of_spectrum(SMALLEST_REAL);
 
  // We assume B is set in system assembly
  // For coercive problems, B is set to the inner product matrix
  // For non-coercive time-dependent problems, B is set to the mass matrix
 
  // Set matrix A corresponding to mu_star
  matrix_A->zero();
  for (unsigned int q=0; q<get_rb_theta_expansion().get_n_A_terms(); q++)
    {
      add_scaled_symm_Aq(q, get_rb_theta_expansion().eval_A_theta(q,get_parameters()));
    }
 
  set_eigensolver_properties(-1);
  solve();
  // TODO: Assert convergence for eigensolver
 
  unsigned int nconv = get_n_converged();
  if (nconv != 0)
    {
      std::pair<Real, Real> eval = get_eigenpair(0);
 
      // ensure that the eigenvalue is real
      libmesh_assert_less (eval.second, TOLERANCE);
 
      // Store the coercivity constant corresponding to mu_star
      rb_scm_eval->set_C_J_stability_constraint(j,eval.first);
      libMesh::out << std::endl << "Stability constant for C_J("<<j<<") = "
                   << rb_scm_eval->get_C_J_stability_constraint(j) << std::endl << std::endl;
 
      // Compute and store the vector y = (y_1, \ldots, y_Q) for the
      // eigenvector currently stored in eigen_system.solution.
      // We use this later to compute the SCM upper bounds.
      Real norm_B2 = libmesh_real( B_inner_product(*solution, *solution) );
 
      for (unsigned int q=0; q<get_rb_theta_expansion().get_n_A_terms(); q++)
        {
          Real norm_Aq2 = libmesh_real( Aq_inner_product(q, *solution, *solution) );
 
          rb_scm_eval->set_SCM_UB_vector(j,q,norm_Aq2/norm_B2);
        }
    }
  else
    libmesh_error_msg("Error: Eigensolver did not converge in evaluate_stability_constant");
}

References add_scaled_symm_Aq(), Aq_inner_product(), B_inner_product(), libMesh::RBSCMEvaluation::C_J, libMesh::EigenSystem::eigen_solver, libMesh::RBSCMEvaluation::get_C_J_stability_constraint(), libMesh::CondensedEigenSystem::get_eigenpair(), libMesh::RBThetaExpansion::get_n_A_terms(), libMesh::EigenSystem::get_n_converged(), libMesh::RBParametrized::get_parameters(), get_rb_theta_expansion(), libMesh::libmesh_real(), libMesh::EigenSystem::matrix_A, libMesh::out, rb_scm_eval, libMesh::Real, libMesh::RBSCMEvaluation::set_C_J_stability_constraint(), set_eigensolver_properties(), libMesh::RBSCMEvaluation::set_SCM_UB_vector(), libMesh::SMALLEST_REAL, libMesh::System::solution, libMesh::CondensedEigenSystem::solve(), libMesh::TOLERANCE, and libMesh::SparseMatrix< T >::zero().

Referenced by perform_SCM_greedy().

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

{
  libmesh_not_implemented();
}

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

◆ generalized()

bool libMesh::EigenSystem::generalized ( ) const

inherited

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

Definition at line 325 of file eigen_system.C.

{
  return _eigen_problem_type == GNHEP ||
         _eigen_problem_type == GHEP ||
         _eigen_problem_type == GHIEP;
}

References libMesh::EigenSystem::_eigen_problem_type, libMesh::GHEP, libMesh::GHIEP, and libMesh::GNHEP.

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::EigenSystem::get_matrix_B(), libMesh::EigenSystem::get_matrix_B(), libMesh::EigenSystem::get_shell_matrix_B(), libMesh::EigenSystem::get_shell_matrix_B(), libMesh::CondensedEigenSystem::solve(), and libMesh::EigenSystem::solve_helper().

◆ generate_training_parameters_deterministic()

std::pair< std::size_t, std::size_t > libMesh::RBConstructionBase< CondensedEigenSystem >::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 217 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< CondensedEigenSystem >::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 199 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_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.

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

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

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

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

References libMesh::System::get_vector().

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

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

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(), HeatSystem::element_qoi_derivative(), 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().

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

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

References libMesh::System::get_vector().

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

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

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

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

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

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

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

◆ get_condensed_matrix_A()

SparseMatrix< Number > & libMesh::CondensedEigenSystem::get_condensed_matrix_A ( )

inherited

Returns: The system matrix used for standard eigenvalue problems

Definition at line 264 of file condensed_eigen_system.C.

{
  libmesh_assert(_condensed_matrix_A);
  return *_condensed_matrix_A;
}

References libMesh::CondensedEigenSystem::_condensed_matrix_A, and libMesh::libmesh_assert().

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices().

◆ get_condensed_matrix_B()

SparseMatrix< Number > & libMesh::CondensedEigenSystem::get_condensed_matrix_B ( )

inherited

Returns: The second system matrix used for generalized eigenvalue problems.

Definition at line 270 of file condensed_eigen_system.C.

{
  libmesh_assert(_condensed_matrix_B);
  return *_condensed_matrix_B;
}

References libMesh::CondensedEigenSystem::_condensed_matrix_B, and libMesh::libmesh_assert().

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices().

◆ get_condensed_precond_matrix()

SparseMatrix< Number > & libMesh::CondensedEigenSystem::get_condensed_precond_matrix ( )

inherited

Returns: The condensed preconditioning matrix

Definition at line 276 of file condensed_eigen_system.C.

{
  libmesh_assert(_condensed_precond_matrix);
  return *_condensed_precond_matrix;
}

References libMesh::CondensedEigenSystem::_condensed_precond_matrix, and libMesh::libmesh_assert().

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices().

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

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

◆ get_deterministic_training_parameter_name()

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

inherited

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

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

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

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

◆ get_dof_map() [1/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.

{
  return *_dof_map;
}

References libMesh::System::_dof_map.

◆ get_dof_map() [2/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.

{
  return *_dof_map;
}

References libMesh::System::_dof_map.

◆ get_eigen_solver() [1/2]

EigenSolver< Number > & libMesh::EigenSystem::get_eigen_solver ( )

inherited

Returns: A reference to the EigenSolver.

Definition at line 489 of file eigen_system.C.

{
  libmesh_assert(eigen_solver);
  return *eigen_solver;
}

References libMesh::EigenSystem::eigen_solver, and libMesh::libmesh_assert().

◆ get_eigen_solver() [2/2]

const EigenSolver< Number > & libMesh::EigenSystem::get_eigen_solver ( ) const

inherited

Returns: A const reference to the EigenSolver.

Definition at line 482 of file eigen_system.C.

{
  libmesh_assert(eigen_solver);
  return *eigen_solver;
}

References libMesh::EigenSystem::eigen_solver, and libMesh::libmesh_assert().

Referenced by main().

◆ get_eigenpair()

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

overridevirtualinherited

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

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

Reimplemented from libMesh::EigenSystem.

Definition at line 218 of file condensed_eigen_system.C.

{
  LOG_SCOPE("get_eigenpair()", "CondensedEigenSystem");
 
  // If we haven't initialized any condensed dofs,
  // just use the default eigen_system
  if (!_have_condensed_dofs)
    return Parent::get_eigenpair(i);
 
  // If we reach here, then there should be some non-condensed dofs
  libmesh_assert(!local_non_condensed_dofs_vector.empty());
 
  // This function assumes that condensed_solve has just been called.
  // If this is not the case, then we will trip an asset in get_eigenpair
  std::unique_ptr<NumericVector<Number>> temp = NumericVector<Number>::build(this->comm());
  const dof_id_type n_local =
    cast_int<dof_id_type>(local_non_condensed_dofs_vector.size());
  dof_id_type n       = n_local;
  this->comm().sum(n);
 
  temp->init (n, n_local, false, PARALLEL);
 
  std::pair<Real, Real> eval = eigen_solver->get_eigenpair (i, *temp);
 
  // Now map temp to solution. Loop over local entries of local_non_condensed_dofs_vector
  libmesh_assert(this->comm().verify(this->solution->closed()));
  if (!this->solution->closed())
    this->solution->close();
  this->solution->zero();
  for (auto j : make_range(n_local))
    {
      const dof_id_type index = local_non_condensed_dofs_vector[j];
      solution->set(index,(*temp)(temp->first_local_index()+j));
    }
 
  // Enforcing constraints requires creating a ghosted version of the solution, which requires the
  // solution be assembled
  solution->close();
  get_dof_map().enforce_constraints_exactly(*this);
  this->update();
 
  return eval;
}

References libMesh::CondensedEigenSystem::_have_condensed_dofs, libMesh::NumericVector< T >::build(), libMesh::ParallelObject::comm(), libMesh::EigenSystem::eigen_solver, libMesh::DofMap::enforce_constraints_exactly(), libMesh::System::get_dof_map(), libMesh::EigenSystem::get_eigenpair(), libMesh::libmesh_assert(), libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector, libMesh::make_range(), libMesh::PARALLEL, libMesh::System::solution, libMesh::Parallel::Communicator::sum(), and libMesh::System::update().

Referenced by compute_SCM_bounding_box(), evaluate_stability_constant(), and main().

◆ get_eigenproblem_type()

EigenProblemType libMesh::EigenSystem::get_eigenproblem_type ( ) const

inlineinherited

Returns: The eigen problem type.

Definition at line 145 of file eigen_system.h.

145{return _eigen_problem_type;}

References libMesh::EigenSystem::_eigen_problem_type.

◆ get_eigenvalue()

std::pair< Real, Real > libMesh::EigenSystem::get_eigenvalue ( dof_id_type i )

virtualinherited

Returns: Real and imaginary part of the ith eigenvalue but does not copy the respective eigen vector to the solution vector.

Definition at line 314 of file eigen_system.C.

{
  return eigen_solver->get_eigenvalue (i);
}

References libMesh::EigenSystem::eigen_solver.

◆ get_equation_systems() [1/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.

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

References libMesh::System::_equation_systems.

◆ get_equation_systems() [2/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.

767{ return _equation_systems; }

References libMesh::System::_equation_systems.

◆ get_first_local_training_index()

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

inherited

Get the first local index of the training parameters.

Definition at line 128 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< CondensedEigenSystem >::get_global_max_error_pair	(	const Parallel::Communicator &	communicator,
		std::pair< numeric_index_type, Real > &	error_pair
	)

staticprotectedinherited

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

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

{
#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
}

References libMesh::ReferenceCounter::_counts.

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

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

{
#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
}

References libMesh::ReferenceCounter::_counts.

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

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

{
  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();
}

References libMesh::make_range(), libMesh::VariableGroup::n_variables(), and libMesh::VariableGroup::name().

Referenced by SystemsTest::testUninitializedInfo().

◆ get_last_local_training_index()

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

inherited

Get the last local index of the training parameters.

Definition at line 133 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< CondensedEigenSystem >::get_local_n_training_samples ( ) const

inherited

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

Definition at line 123 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 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_matrix() [1/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.

{
  return *libmesh_map_find(_matrices, mat_name);
}

References libMesh::System::_matrices.

◆ get_matrix() [2/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.

{
  return *libmesh_map_find(_matrices, mat_name);
}

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(), libMesh::ImplicitSystem::get_system_matrix(), main(), libMesh::EigenTimeSolver::solve(), and libMesh::NewmarkSystem::update_rhs().

◆ get_matrix_A() [1/2]

SparseMatrix< Number > & libMesh::EigenSystem::get_matrix_A ( )

inherited

Returns: A reference to the system matrix used for standard eigenvalue problems.

This matrix should only be available (and therefore this should only be called) if !_use_shell_matrices.

Definition at line 342 of file eigen_system.C.

{
  libmesh_assert(matrix_A);
  libmesh_assert(!_use_shell_matrices);
  libmesh_assert(has_matrix_A());
  return *matrix_A;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::has_matrix_A(), libMesh::libmesh_assert(), and libMesh::EigenSystem::matrix_A.

◆ get_matrix_A() [2/2]

const SparseMatrix< Number > & libMesh::EigenSystem::get_matrix_A ( ) const

inherited

Returns: A const reference to the system matrix used for standard eigenvalue problems.

This matrix should only be available (and therefore this should only be called) if !_use_shell_matrices.

Definition at line 333 of file eigen_system.C.

{
  libmesh_assert(matrix_A);
  libmesh_assert(!_use_shell_matrices);
  libmesh_assert(has_matrix_A());
  return *matrix_A;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::has_matrix_A(), libMesh::libmesh_assert(), and libMesh::EigenSystem::matrix_A.

Referenced by add_scaled_symm_Aq(), assemble_mass(), assemble_matrices(), and assemble_SchroedingerEquation().

◆ get_matrix_B() [1/2]

SparseMatrix< Number > & libMesh::EigenSystem::get_matrix_B ( )

inherited

Returns: A const reference to the system matrix used for generalized eigenvalue problems

This matrix should only be available (and therefore this should only be called) if !_use_shell_matrices and generalized().

Definition at line 361 of file eigen_system.C.

{
  libmesh_assert(matrix_B);
  libmesh_assert(!_use_shell_matrices);
  libmesh_assert(generalized());
  libmesh_assert(has_matrix_B());
  return *matrix_B;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::generalized(), libMesh::EigenSystem::has_matrix_B(), libMesh::libmesh_assert(), and libMesh::EigenSystem::matrix_B.

◆ get_matrix_B() [2/2]

const SparseMatrix< Number > & libMesh::EigenSystem::get_matrix_B ( ) const

inherited

Returns: A const reference to the system matrix used for generalized eigenvalue problems

This matrix should only be available (and therefore this should only be called) if !_use_shell_matrices and generalized().

Definition at line 351 of file eigen_system.C.

{
  libmesh_assert(matrix_B);
  libmesh_assert(!_use_shell_matrices);
  libmesh_assert(generalized());
  libmesh_assert(has_matrix_B());
  return *matrix_B;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::generalized(), libMesh::EigenSystem::has_matrix_B(), libMesh::libmesh_assert(), and libMesh::EigenSystem::matrix_B.

Referenced by assemble_mass(), assemble_matrices(), and assemble_SchroedingerEquation().

◆ get_mesh() [1/2]

MeshBase & libMesh::System::get_mesh ( )

inlineinherited

Returns: A reference to this systems's _mesh.

Definition at line 2409 of file system.h.

{
  return _mesh;
}

References libMesh::System::_mesh.

◆ get_mesh() [2/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.

{
  return _mesh;
}

References libMesh::System::_mesh.

Referenced by libMesh::ExactSolution::_compute_error(), LinearElasticityWithContact::add_contact_edge_elements(), libMesh::PetscDMWrapper::add_dofs_to_section(), libMesh::System::add_matrix(), libMesh::HPCoarsenTest::add_projection(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), libMesh::DofMap::add_variables(), AssembleOptimization::assemble_A_and_F(), libMesh::ClawSystem::assemble_advection_matrices(), libMesh::ClawSystem::assemble_avg_coupling_matrices(), libMesh::ClawSystem::assemble_boundary_condition_matrices(), libMesh::ClawSystem::assemble_jump_coupling_matrix(), libMesh::ClawSystem::assemble_mass_matrix(), libMesh::FEMSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::FEMSystem::assembly(), libMesh::VariationalSmootherSystem::assembly(), AssemblyF0::boundary_assembly(), AssemblyF1::boundary_assembly(), AssemblyF2::boundary_assembly(), AssemblyA0::boundary_assembly(), AssemblyA1::boundary_assembly(), AssemblyA2::boundary_assembly(), compute_jacobian(), libMesh::VariationalSmootherSystem::compute_mesh_quality_info(), compute_residual(), LinearElasticityWithContact::compute_stresses(), libMesh::VariationalSmootherConstraint::constrain(), libMesh::VariationalSmootherConstraint::constrain_node_to_line(), libMesh::VariationalSmootherConstraint::constrain_node_to_plane(), libMesh::ImplicitSystem::create_static_condensation_system_matrix(), libMesh::RBEIMEvaluation::distribute_bfs(), DMCreateDomainDecomposition_libMesh(), DMCreateFieldDecomposition_libMesh(), DMlibMeshSetSystem_libMesh(), NavierSystem::element_constraint(), HeatSystem::element_time_derivative(), NavierSystem::element_time_derivative(), SolidSystem::element_time_derivative(), libMesh::RBConstruction::enrich_basis_from_rhs_terms(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_interiors(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_sides(), libMesh::AdjointResidualErrorEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::PatchRecoveryErrorEstimator::estimate_error(), libMesh::WeightedPatchRecoveryErrorEstimator::estimate_error(), libMesh::SmoothnessEstimator::estimate_smoothness(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::VariationalSmootherConstraint::fix_node(), NavierSystem::forcing(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::GenericProjector(), LinearElasticityWithContact::get_least_and_max_gap_function(), AssemblyPointLoadX::get_nodal_rhs_values(), AssemblyPointLoadY::get_nodal_rhs_values(), AssemblyPointLoadZ::get_nodal_rhs_values(), libMesh::SystemSubsetBySubdomain::init(), libMesh::RBEIMConstruction::init_context(), NavierSystem::init_data(), SolidSystem::init_data(), ElasticitySystem::init_data(), ElasticityRBConstruction::init_data(), libMesh::System::init_data(), libMesh::VariationalSmootherSystem::init_data(), libMesh::System::init_matrices(), libMesh::PetscDMWrapper::init_petscdm(), LinearElasticityWithContact::initialize_contact_load_paths(), libMesh::RBEIMConstruction::initialize_qp_data(), libMesh::System::local_dof_indices(), NavierSystem::mass_residual(), libMesh::DofMap::max_constraint_error(), libMesh::FEMSystem::mesh_position_get(), libMesh::FEMSystem::mesh_position_set(), LinearElasticityWithContact::move_mesh(), libMesh::RBEIMEvaluation::node_distribute_bfs(), Integrate::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::SmoothnessEstimator::EstimateSmoothness::operator()(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::petsc_auto_fieldsplit(), NavierSystem::postprocess(), libMesh::FEMSystem::postprocess(), libMesh::RBParametrizedFunction::preevaluate_parametrized_function_on_mesh(), libMesh::RBParametrizedFunction::preevaluate_parametrized_function_on_mesh_sides(), libMesh::VariationalSmootherSystem::prepare_for_smoothing(), libMesh::System::read_header(), libMesh::RBEvaluation::read_in_vectors_from_multiple_files(), libMesh::System::read_parallel_data(), libMesh::System::read_serialized_vector(), libMesh::System::read_serialized_vectors(), libMesh::System::reinit(), LinearElasticityWithContact::residual_and_jacobian(), OverlappingAlgebraicGhostingTest::run_ghosting_test(), OverlappingCouplingGhostingTest::run_sparsity_pattern_test(), SolidSystem::save_initial_mesh(), libMesh::HPSingularity::select_refinement(), libMesh::HPCoarsenTest::select_refinement(), libMesh::PetscPreconditioner< T >::set_hypre_ads_data(), libMesh::PetscPreconditioner< T >::set_hypre_ams_data(), libMesh::PetscPreconditioner< T >::set_petsc_aux_data(), libMesh::PetscDMWrapper::set_point_range_in_section(), NavierSystem::side_constraint(), libMesh::RBEIMEvaluation::side_distribute_bfs(), SolidSystem::side_time_derivative(), libMesh::PetscDiffSolver::solve(), libMesh::ClawSystem::solve_conservation_law(), MeshAssignTest::testMeshMoveAssign(), libMesh::BoundaryVolumeSolutionTransfer::transfer(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), libMesh::RBConstruction::truth_solve(), libMesh::TransientRBConstruction::truth_solve(), libMesh::System::write_header(), libMesh::RBEvaluation::write_out_vectors(), libMesh::System::write_parallel_data(), libMesh::System::write_serialized_vector(), libMesh::System::write_serialized_vectors(), and libMesh::System::zero_variable().

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

{
  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());
}

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

◆ get_n_converged()

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

inlineinherited

Returns: The number of converged eigenpairs.

Definition at line 130 of file eigen_system.h.

130{return _n_converged_eigenpairs;}

libMesh::EigenSystem::_n_converged_eigenpairs

unsigned int _n_converged_eigenpairs

The number of converged eigenpairs.

Definition eigen_system.h:399

References libMesh::EigenSystem::_n_converged_eigenpairs.

Referenced by compute_SCM_bounding_box(), evaluate_stability_constant(), and main().

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

{
  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());
}

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

◆ get_n_iterations()

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

inlineinherited

Returns: The number of eigen solver iterations.

Definition at line 135 of file eigen_system.h.

135{return _n_iterations;}

libMesh::EigenSystem::_n_iterations

unsigned int _n_iterations

The number of iterations of the eigen solver algorithm.

Definition eigen_system.h:404

References libMesh::EigenSystem::_n_iterations.

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

{
  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();
}

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::RBEIMConstruction::print_info(), print_info(), libMesh::RBConstruction::print_info(), libMesh::RBEIMEvaluation::set_eim_error_indicator_active(), and libMesh::RBConstruction::train_reduced_basis_with_POD().

◆ get_n_training_samples()

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

inherited

Get the number of global training samples.

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

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

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

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

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

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

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

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

◆ get_parameters()

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

inherited

Get the current parameters.

Definition at line 143 of file rb_parametrized.C.

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

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(), compute_SCM_bounds_on_training_set(), 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(), 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(), main(), libMesh::TransientRBConstruction::mass_matrix_scaled_matvec(), libMesh::RBConstruction::preevaluate_thetas(), libMesh::RBEIMConstruction::print_info(), print_info(), libMesh::RBConstruction::print_info(), libMesh::RBParametrized::print_parameters(), 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::RBConstruction::truth_assembly(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::RBConstruction::truth_solve(), libMesh::TransientRBConstruction::truth_solve(), libMesh::TransientRBEvaluation::uncached_compute_residual_dual_norm(), and libMesh::RBConstruction::update_greedy_param_list().

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

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

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

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

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

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

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

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

◆ get_params_from_training_set()

RBParameters libMesh::RBConstructionBase< CondensedEigenSystem >::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 238 of file rb_construction_base.C.

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

SparseMatrix< Number > & libMesh::EigenSystem::get_precond_matrix ( )

inherited

Returns: A reference to the preconditioning matrix.

This matrix should only be available (and therefore this should only be called) if !_use_shell_matrices.

Definition at line 381 of file eigen_system.C.

{
  libmesh_assert(precond_matrix);
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(!_use_shell_precond_matrix);
  libmesh_assert(has_precond_matrix());
  return *precond_matrix;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::_use_shell_precond_matrix, libMesh::EigenSystem::has_precond_matrix(), libMesh::libmesh_assert(), and libMesh::EigenSystem::precond_matrix.

◆ get_precond_matrix() [2/2]

const SparseMatrix< Number > & libMesh::EigenSystem::get_precond_matrix ( ) const

inherited

Returns: A const reference to the preconditioning matrix.

This matrix should only be available (and therefore this should only be called) if !_use_shell_matrices.

Definition at line 371 of file eigen_system.C.

{
  libmesh_assert(precond_matrix);
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(!_use_shell_precond_matrix);
  libmesh_assert(has_precond_matrix());
  return *precond_matrix;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::_use_shell_precond_matrix, libMesh::EigenSystem::has_precond_matrix(), libMesh::libmesh_assert(), and libMesh::EigenSystem::precond_matrix.

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

  {
    return project_with_constraints;
  }

References libMesh::System::project_with_constraints.

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

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

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

References libMesh::libmesh_assert().

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

◆ get_qoi_value()

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

inherited

Definition at line 2184 of file system.C.

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

References libMesh::libmesh_assert().

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

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

{
  return this->_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().

◆ get_rb_scm_evaluation()

RBSCMEvaluation & libMesh::RBSCMConstruction::get_rb_scm_evaluation ( )

Get a reference to the RBSCMEvaluation object.

Definition at line 77 of file rb_scm_construction.C.

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

References rb_scm_eval.

Referenced by get_rb_theta_expansion().

◆ get_rb_theta_expansion()

RBThetaExpansion & libMesh::RBSCMConstruction::get_rb_theta_expansion ( )

Get a reference to the RBThetaExpansion object.

Definition at line 84 of file rb_scm_construction.C.

{
  return get_rb_scm_evaluation().get_rb_theta_expansion();
}

References get_rb_scm_evaluation(), and libMesh::RBSCMEvaluation::get_rb_theta_expansion().

Referenced by Aq_inner_product(), compute_SCM_bounding_box(), enrich_C_J(), evaluate_stability_constant(), print_info(), and resize_SCM_vectors().

◆ get_SCM_training_tolerance()

Real libMesh::RBSCMConstruction::get_SCM_training_tolerance ( ) const

inline

Get/set SCM_training_tolerance: tolerance for SCM greedy.

Definition at line 145 of file rb_scm_construction.h.

145{ return SCM_training_tolerance; }

References SCM_training_tolerance.

Referenced by print_info().

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

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

References libMesh::System::get_vector().

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

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

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

References libMesh::System::get_vector().

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

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

References libMesh::System::get_vector().

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

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

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

References libMesh::System::get_vector().

◆ get_shell_matrix_A() [1/2]

ShellMatrix< Number > & libMesh::EigenSystem::get_shell_matrix_A ( )

inherited

Returns: A reference to the system shell matrix used for standard eigenvalue problems.

This matrix should only be available (and therefore this should only be called) if _use_shell_matrices.

Definition at line 399 of file eigen_system.C.

{
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(has_shell_matrix_A());
  return *shell_matrix_A;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::has_shell_matrix_A(), libMesh::libmesh_assert(), and libMesh::EigenSystem::shell_matrix_A.

◆ get_shell_matrix_A() [2/2]

const ShellMatrix< Number > & libMesh::EigenSystem::get_shell_matrix_A ( ) const

inherited

Returns: A const reference to the system shell matrix used for standard eigenvalue problems.

This matrix should only be available (and therefore this should only be called) if _use_shell_matrices.

Definition at line 391 of file eigen_system.C.

{
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(has_shell_matrix_A());
  return *shell_matrix_A;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::has_shell_matrix_A(), libMesh::libmesh_assert(), and libMesh::EigenSystem::shell_matrix_A.

◆ get_shell_matrix_B() [1/2]

ShellMatrix< Number > & libMesh::EigenSystem::get_shell_matrix_B ( )

inherited

Returns: A reference to the system shell matrix used for generalized eigenvalue problems.

This matrix should only be available (and therefore this should only be called) if _use_shell_matrices and generalized().

Definition at line 416 of file eigen_system.C.

{
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(generalized());
  libmesh_assert(has_shell_matrix_B());
  return *shell_matrix_B;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::generalized(), libMesh::EigenSystem::has_shell_matrix_B(), libMesh::libmesh_assert(), and libMesh::EigenSystem::shell_matrix_B.

◆ get_shell_matrix_B() [2/2]

const ShellMatrix< Number > & libMesh::EigenSystem::get_shell_matrix_B ( ) const

inherited

Returns: A const reference to the system shell matrix used for generalized eigenvalue problems.

This matrix should only be available (and therefore this should only be called) if _use_shell_matrices and generalized().

Definition at line 407 of file eigen_system.C.

{
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(generalized());
  libmesh_assert(has_shell_matrix_B());
  return *shell_matrix_B;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::generalized(), libMesh::EigenSystem::has_shell_matrix_B(), libMesh::libmesh_assert(), and libMesh::EigenSystem::shell_matrix_B.

◆ get_shell_precond_matrix() [1/2]

ShellMatrix< Number > & libMesh::EigenSystem::get_shell_precond_matrix ( )

inherited

Returns: A reference to the system shell matrix used for preconditioning.

Definition at line 434 of file eigen_system.C.

{
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(_use_shell_precond_matrix);
  libmesh_assert(has_shell_precond_matrix());
  return *shell_precond_matrix;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::_use_shell_precond_matrix, libMesh::EigenSystem::has_shell_precond_matrix(), libMesh::libmesh_assert(), and libMesh::EigenSystem::shell_precond_matrix.

◆ get_shell_precond_matrix() [2/2]

const ShellMatrix< Number > & libMesh::EigenSystem::get_shell_precond_matrix ( ) const

inherited

Returns: A const reference to the system shell matrix used for preconditioning.

Definition at line 425 of file eigen_system.C.

{
  libmesh_assert(_use_shell_matrices);
  libmesh_assert(_use_shell_precond_matrix);
  libmesh_assert(has_shell_precond_matrix());
  return *shell_precond_matrix;
}

References libMesh::EigenSystem::_use_shell_matrices, libMesh::EigenSystem::_use_shell_precond_matrix, libMesh::EigenSystem::has_shell_precond_matrix(), libMesh::libmesh_assert(), and libMesh::EigenSystem::shell_precond_matrix.

◆ get_vector() [1/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.

{
  // 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);
}

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

◆ get_vector() [2/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.

{
  // 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);
}

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

◆ get_vector() [3/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.

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

References libMesh::System::_vectors.

◆ get_vector() [4/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.

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

References libMesh::System::_vectors.

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

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

References libMesh::System::get_vector().

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

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

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

References libMesh::System::get_vector().

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

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

References libMesh::System::get_vector().

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

◆ get_weighted_sensitivity_solution() [2/2]

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

inherited

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

Definition at line 1213 of file system.C.

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

References libMesh::System::get_vector().

◆ has_condensed_matrix_A()

bool libMesh::CondensedEigenSystem::has_condensed_matrix_A ( ) const

inlineinherited

Definition at line 121 of file condensed_eigen_system.h.

121{ return _condensed_matrix_A.get(); }

References libMesh::CondensedEigenSystem::_condensed_matrix_A.

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices().

◆ has_condensed_matrix_B()

bool libMesh::CondensedEigenSystem::has_condensed_matrix_B ( ) const

inlineinherited

Definition at line 122 of file condensed_eigen_system.h.

122{ return _condensed_matrix_B.get(); }

References libMesh::CondensedEigenSystem::_condensed_matrix_B.

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices().

◆ has_condensed_precond_matrix()

bool libMesh::CondensedEigenSystem::has_condensed_precond_matrix ( ) const

inlineinherited

Definition at line 123 of file condensed_eigen_system.h.

123{ return _condensed_precond_matrix.get(); }

References libMesh::CondensedEigenSystem::_condensed_precond_matrix.

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices().

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

{
  return _constrain_system_object != nullptr;
}

◆ has_matrix_A()

bool libMesh::EigenSystem::has_matrix_A ( ) const

inherited

Returns: Whether or not the system has matrix A

Definition at line 443 of file eigen_system.C.

{
  libmesh_assert_equal_to(request_matrix("Eigen Matrix A"), matrix_A);
  return matrix_A;
}

References libMesh::EigenSystem::matrix_A, and libMesh::System::request_matrix().

Referenced by libMesh::EigenSystem::get_matrix_A(), and libMesh::EigenSystem::get_matrix_A().

◆ has_matrix_B()

bool libMesh::EigenSystem::has_matrix_B ( ) const

inherited

Returns: Whether or not the system has matrix B

Definition at line 450 of file eigen_system.C.

{
  libmesh_assert_equal_to(request_matrix("Eigen Matrix B"), matrix_B);
  return matrix_B;
}

References libMesh::EigenSystem::matrix_B, and libMesh::System::request_matrix().

Referenced by libMesh::EigenSystem::get_matrix_B(), and libMesh::EigenSystem::get_matrix_B().

◆ has_precond_matrix()

bool libMesh::EigenSystem::has_precond_matrix ( ) const

inherited

Returns: Whether or not the system has the non-shell preconditioning matrix

Definition at line 457 of file eigen_system.C.

{
  libmesh_assert_equal_to(request_matrix("Eigen Preconditioner"), precond_matrix);
  return precond_matrix;
}

References libMesh::EigenSystem::precond_matrix, and libMesh::System::request_matrix().

Referenced by libMesh::EigenSystem::get_precond_matrix(), and libMesh::EigenSystem::get_precond_matrix().

◆ has_shell_matrix_A()

bool libMesh::EigenSystem::has_shell_matrix_A ( ) const

inherited

Returns: Whether or not the system has the shell matrix A

Definition at line 464 of file eigen_system.C.

{
  return shell_matrix_A.get();
}

References libMesh::EigenSystem::shell_matrix_A.

Referenced by libMesh::EigenSystem::get_shell_matrix_A(), and libMesh::EigenSystem::get_shell_matrix_A().

◆ has_shell_matrix_B()

bool libMesh::EigenSystem::has_shell_matrix_B ( ) const

inherited

Returns: Whether or not the system has the shell matrix B

Definition at line 470 of file eigen_system.C.

{
  return shell_matrix_B.get();
}

References libMesh::EigenSystem::shell_matrix_B.

Referenced by libMesh::EigenSystem::get_shell_matrix_B(), and libMesh::EigenSystem::get_shell_matrix_B().

◆ has_shell_precond_matrix()

bool libMesh::EigenSystem::has_shell_precond_matrix ( ) const

inherited

Returns: Whether or not the system has the shell preconditioning matrix

Definition at line 476 of file eigen_system.C.

{
  return shell_precond_matrix.get();
}

References libMesh::EigenSystem::shell_precond_matrix.

Referenced by libMesh::EigenSystem::get_shell_precond_matrix(), and libMesh::EigenSystem::get_shell_precond_matrix().

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

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

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

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

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

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

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

◆ have_condensed_dofs()

bool libMesh::CondensedEigenSystem::have_condensed_dofs ( ) const

inlineinherited

Returns: Whether there are condensed degrees of freedom

Definition at line 187 of file condensed_eigen_system.h.

188 { libmesh_assert(_condensed_dofs_initialized); return _have_condensed_dofs; }

libMesh::CondensedEigenSystem::_condensed_dofs_initialized

bool _condensed_dofs_initialized

A private flag to indicate whether the condensed dofs have been initialized.

Definition condensed_eigen_system.h:202

References libMesh::CondensedEigenSystem::_condensed_dofs_initialized, libMesh::CondensedEigenSystem::_have_condensed_dofs, and libMesh::libmesh_assert().

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

1933{ return _matrices.count(mat_name); }

References libMesh::System::_matrices.

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

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

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

References libMesh::System::_vectors.

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

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

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

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

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

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

{
  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();
  }
}

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

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

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

{
  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();
  }
}

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

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

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

{
  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();
  }
}

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

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

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

{
  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();
  }
}

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

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

◆ init()

void libMesh::System::init ( )

inherited

Initializes degrees of freedom on the current mesh.

Sets the

Definition at line 196 of file system.C.

{
  // 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();
}

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

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

◆ init_data()

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

protectedvirtualinherited

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

Reimplemented from libMesh::System.

Definition at line 231 of file rb_construction_base.C.

{
  Base::init_data();
 
  // Initialize the inner product storage vector, which is useful for
  // storing intermediate results when evaluating inner products
  inner_product_storage_vector = NumericVector<Number>::build(this->comm());
  inner_product_storage_vector->init (this->n_dofs(), this->n_local_dofs(), false, PARALLEL);
}

◆ init_matrices()

void libMesh::EigenSystem::init_matrices ( )

overrideprotectedvirtualinherited

Initializes the matrices associated with the system.

Reimplemented from libMesh::System.

Definition at line 158 of file eigen_system.C.

{
  Parent::init_matrices();
 
  const bool condense_constraints = condense_constrained_dofs();
  if (shell_matrix_A)
    {
      shell_matrix_A->attach_dof_map(this->get_dof_map());
      if (condense_constraints)
        shell_matrix_A->omit_constrained_dofs();
      shell_matrix_A->init();
    }
 
  if (shell_matrix_B)
    {
      shell_matrix_B->attach_dof_map(this->get_dof_map());
      if (condense_constraints)
        shell_matrix_B->omit_constrained_dofs();
      shell_matrix_B->init();
    }
 
  if (shell_precond_matrix)
    {
      shell_precond_matrix->attach_dof_map(this->get_dof_map());
      if (condense_constraints)
        shell_precond_matrix->omit_constrained_dofs();
      shell_precond_matrix->init();
    }
}

References libMesh::System::condense_constrained_dofs(), libMesh::System::get_dof_map(), libMesh::System::init_matrices(), libMesh::EigenSystem::shell_matrix_A, libMesh::EigenSystem::shell_matrix_B, and libMesh::EigenSystem::shell_precond_matrix.

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

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

Referenced by CoupledSystem::CoupledSystem(), HeatSystem::HeatSystem(), LaplaceQoI::init_qoi_count(), CoupledSystemQoI::init_qoi_count(), LaplaceSystem::LaplaceSystem(), main(), and PoissonSystem::PoissonSystem().

◆ initialize_condensed_dofs()

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

inherited

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

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

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

Definition at line 49 of file condensed_eigen_system.C.

{
  const DofMap & dof_map = this->get_dof_map();
  if (global_dirichlet_dofs_set.empty() && !dof_map.n_constrained_dofs())
    {
      _have_condensed_dofs = false;
      _condensed_dofs_initialized = true;
      return;
    }
 
  // First, put all unconstrained local dofs into non_dirichlet_dofs_set
  std::set<dof_id_type> local_non_condensed_dofs_set;
  for (auto i : make_range(dof_map.first_dof(), dof_map.end_dof()))
#if LIBMESH_ENABLE_CONSTRAINTS
    if (!dof_map.is_constrained_dof(i))
#endif
      local_non_condensed_dofs_set.insert(i);
 
  // Now erase the condensed dofs
  for (const auto dof : global_dirichlet_dofs_set)
    if ((dof_map.first_dof() <= dof) && (dof < dof_map.end_dof()))
      local_non_condensed_dofs_set.erase(dof);
 
  // Finally, move local_non_condensed_dofs_set over to a vector for convenience in solve()
  this->local_non_condensed_dofs_vector.clear();
 
  for (const auto dof : local_non_condensed_dofs_set)
    this->local_non_condensed_dofs_vector.push_back(dof);
 
  _have_condensed_dofs = true;
  _condensed_dofs_initialized = true;
}

References libMesh::CondensedEigenSystem::_condensed_dofs_initialized, libMesh::CondensedEigenSystem::_have_condensed_dofs, libMesh::DofMapBase::end_dof(), libMesh::DofMapBase::first_dof(), libMesh::System::get_dof_map(), libMesh::DofMap::is_constrained_dof(), libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector, libMesh::make_range(), and libMesh::DofMap::n_constrained_dofs().

Referenced by libMesh::CondensedEigenSystem::initialize_condensed_matrices(), main(), and perform_SCM_greedy().

◆ initialize_condensed_matrices()

void libMesh::CondensedEigenSystem::initialize_condensed_matrices ( )

inherited

Initializes the condensed matrices.

This API should be used if the condensed matrices will be assembled during the solve as opposed to pre-solve

Definition at line 90 of file condensed_eigen_system.C.

{
  if (!_condensed_dofs_initialized)
    this->initialize_condensed_dofs();
 
  if (!_have_condensed_dofs)
    return;
 
  const auto m = cast_int<numeric_index_type>(this->local_non_condensed_dofs_vector.size());
  auto M = m;
  _communicator.sum(M);
  if (this->has_condensed_matrix_A())
  {
    this->get_condensed_matrix_A().init(M, M, m, m);
    // A bit ludicrously MatCopy requires the matrix being copied to to be assembled
    this->get_condensed_matrix_A().close();
  }
  if (this->has_condensed_matrix_B())
  {
    this->get_condensed_matrix_B().init(M, M, m, m);
    this->get_condensed_matrix_B().close();
  }
  if (this->has_condensed_precond_matrix())
  {
    this->get_condensed_precond_matrix().init(M, M, m, m);
    this->get_condensed_precond_matrix().close();
  }
}

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

{
  // 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);
}

References libMesh::RBParametrized::_discrete_parameter_values, libMesh::RBParameters::begin_serialized(), libMesh::RBParameters::end_serialized(), libMesh::RBParameters::n_parameters(), libMesh::RBParameters::n_samples(), 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(), perform_SCM_greedy(), process_parameters_file(), libMesh::RBParametrized::read_parameter_data_from_files(), libMesh::RBConstruction::set_rb_construction_parameters(), libMesh::RBEIMConstruction::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().

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

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

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

◆ initialize_training_parameters()

void libMesh::RBConstructionBase< CondensedEigenSystem >::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 142 of file rb_construction_base.C.

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

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

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

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

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

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

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

{
  return _is_initialized;
}

References libMesh::System::_is_initialized.

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

◆ is_quiet()

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

inlineinherited

Is the system in quiet mode?

Definition at line 106 of file rb_construction_base.h.

107 { return this->quiet_mode; }

libMesh::RBConstructionBase< CondensedEigenSystem >::quiet_mode

bool quiet_mode

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

Definition rb_construction_base.h:265

◆ is_value_in_list()

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

staticprivateinherited

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

Definition at line 451 of file rb_parametrized.C.

{
  Real closest_value = get_closest_value(value, list_of_values);
 
  // Check if relative tolerance is satisfied
  Real rel_error = std::abs(value - closest_value) / std::abs(value);
  if (rel_error <= tol)
    {
      return true;
    }
 
  // If relative tolerance isn't satisfied, we should still check an absolute
  // error, since relative tolerance can be misleading if value is close to zero
  Real abs_error = std::abs(value - closest_value);
  return (abs_error <= tol);
}

References libMesh::RBParametrized::get_closest_value(), libMesh::Real, and value.

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

◆ late_matrix_init()

void libMesh::System::late_matrix_init	(	SparseMatrix< Number > &	mat,
		ParallelType	type
	)

privateinherited

Helper function to keep DofMap forward declarable in system.h.

Definition at line 1063 of file system.C.

{
  if (_matrices_initialized)
    {
      this->get_dof_map().attach_matrix(mat);
      mat.init(type);
    }
}

References libMesh::System::_matrices_initialized, libMesh::DofMap::attach_matrix(), libMesh::System::get_dof_map(), and libMesh::SparseMatrix< T >::init().

Referenced by libMesh::System::add_matrix(), libMesh::System::add_matrix(), and libMesh::System::add_matrix().

◆ load_matrix_B()

void libMesh::RBSCMConstruction::load_matrix_B ( )

protectedvirtual

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

Definition at line 213 of file rb_scm_construction.C.

{
  // Load the operators from the RBConstruction
  EquationSystems & es = this->get_equation_systems();
  RBConstruction & rb_system = es.get_system<RBConstruction>(RB_system_name);
 
  matrix_B->zero();
  matrix_B->close();
  matrix_B->add(1.,*rb_system.get_inner_product_matrix());
}

References libMesh::SparseMatrix< T >::add(), libMesh::SparseMatrix< T >::close(), libMesh::System::get_equation_systems(), libMesh::RBConstruction::get_inner_product_matrix(), libMesh::EquationSystems::get_system(), libMesh::EigenSystem::matrix_B, RB_system_name, and libMesh::SparseMatrix< T >::zero().

Referenced by perform_SCM_greedy().

◆ load_training_set()

void libMesh::RBConstructionBase< CondensedEigenSystem >::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 152 of file rb_construction_base.C.

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

{
  // 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);
    }
}

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 SystemsTest::testBlockRestrictedVarNDofs(), and libMesh::DirectSolutionTransfer::transfer().

◆ matrices_begin() [1/2]

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

inlineinherited

Beginning of matrices container.

Definition at line 2529 of file system.h.

{
  return _matrices.begin();
}

References libMesh::System::_matrices.

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

{
  return _matrices.begin();
}

References libMesh::System::_matrices.

◆ matrices_end() [1/2]

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

inlineinherited

End of matrices container.

Definition at line 2541 of file system.h.

{
  return _matrices.end();
}

References libMesh::System::_matrices.

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

{
  return _matrices.end();
}

References libMesh::System::_matrices.

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

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

References libMesh::System::n_constrained_dofs(), and libMesh::System::n_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.

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

Referenced by ElasticityRBConstruction::init_data().

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

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

References libMesh::System::_dof_map.

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

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

{
  return _dof_map->n_dofs();
}

References libMesh::System::_dof_map.

◆ n_global_non_condensed_dofs()

dof_id_type libMesh::CondensedEigenSystem::n_global_non_condensed_dofs ( ) const

inherited

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

Definition at line 119 of file condensed_eigen_system.C.

{
  if (!_have_condensed_dofs)
    return this->n_dofs();
  else
    {
      dof_id_type n_global_non_condensed_dofs =
        cast_int<dof_id_type>(local_non_condensed_dofs_vector.size());
      this->comm().sum(n_global_non_condensed_dofs);
 
      return n_global_non_condensed_dofs;
    }
}

References libMesh::CondensedEigenSystem::_have_condensed_dofs, libMesh::ParallelObject::comm(), libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector, libMesh::System::n_dofs(), libMesh::CondensedEigenSystem::n_global_non_condensed_dofs(), and libMesh::Parallel::Communicator::sum().

Referenced by libMesh::CondensedEigenSystem::n_global_non_condensed_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.

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

References libMesh::System::_dof_map.

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

{
  return _dof_map->n_local_dofs();
}

References libMesh::System::_dof_map.

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

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

References libMesh::System::_matrices.

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

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition reference_counter.h:132

References libMesh::ReferenceCounter::_n_objects.

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

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

86 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

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

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

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

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

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

{
  libmesh_assert_equal_to(this->_qoi.size(), this->_qoi_error_estimates.size());
 
  return cast_int<unsigned int>(this->_qoi.size());
}

References libMesh::System::_qoi.

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::FEMSystem::assemble_qoi(), libMesh::ExplicitSystem::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::TimeSolver::init_adjoints(), libMesh::UnsteadySolver::init_adjoints(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::SteadySolver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::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().

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

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

Referenced by libMesh::FEMSystem::assembly().

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

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

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

References libMesh::System::_vectors.

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

◆ name()

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

inlineinherited

Returns: The system name.

Definition at line 2385 of file system.h.

{
  return _sys_name;
}

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::StaticCondensation::init(), libMesh::NewtonSolver::init(), libMesh::TimeSolver::init_data(), libMesh::System::init_matrices(), main(), output_norms(), libMesh::petsc_auto_fieldsplit(), libMesh::System::prefix(), libMesh::ClawSystem::print_info(), libMesh::RBEIMConstruction::print_info(), print_info(), libMesh::RBConstruction::print_info(), libMesh::TimeSolver::reinit(), libMesh::PetscDiffSolver::setup_petsc_data(), libMesh::FrequencySystem::solve(), libMesh::RBConstruction::truth_solve(), libMesh::System::write_header(), libMesh::System::write_parallel_data(), and libMesh::System::write_serialized_data().

◆ number()

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

inlineinherited

Returns: The system number.

Definition at line 2393 of file system.h.

{
  return _sys_number;
}

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::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ExactErrorEstimator::find_squared_element_error(), libMesh::EquationSystems::find_variable_numbers_by_predicate(), libMesh::VariationalSmootherConstraint::fix_node(), AssemblyPointLoadX::get_nodal_rhs_values(), AssemblyPointLoadY::get_nodal_rhs_values(), AssemblyPointLoadZ::get_nodal_rhs_values(), libMesh::VariationalSmootherSystem::init_data(), main(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::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::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(), MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData(), libMesh::MeshfreeSolutionTransfer::transfer(), libMesh::MeshFunctionSolutionTransfer::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().

◆ operator=() [1/2]

RBSCMConstruction & libMesh::RBSCMConstruction::operator= ( const RBSCMConstruction & )

delete

◆ operator=() [2/2]

RBSCMConstruction & libMesh::RBSCMConstruction::operator= ( RBSCMConstruction && )

delete

◆ perform_SCM_greedy()

void libMesh::RBSCMConstruction::perform_SCM_greedy ( )

virtual

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

Definition at line 224 of file rb_scm_construction.C.

{
  LOG_SCOPE("perform_SCM_greedy()", "RBSCMConstruction");
 
  // initialize rb_scm_eval's parameters
  rb_scm_eval->initialize_parameters(*this);
 
#ifdef LIBMESH_ENABLE_CONSTRAINTS
  // Get a list of constrained dofs from rb_system
  std::set<dof_id_type> constrained_dofs_set;
  EquationSystems & es = this->get_equation_systems();
  RBConstruction & rb_system = es.get_system<RBConstruction>(RB_system_name);
 
  for (dof_id_type i=0; i<rb_system.n_dofs(); i++)
    {
      if (rb_system.get_dof_map().is_constrained_dof(i))
        {
          constrained_dofs_set.insert(i);
        }
    }
 
  // Use these constrained dofs to identify which dofs we want to "get rid of"
  // (i.e. condense) in our eigenproblems.
  this->initialize_condensed_dofs(constrained_dofs_set);
#endif // LIBMESH_ENABLE_CONSTRAINTS
 
  // Copy the inner product matrix over from rb_system to be used as matrix_B
  load_matrix_B();
 
  attach_deflation_space();
 
  compute_SCM_bounding_box();
  // This loads the new parameter into current_parameters
  enrich_C_J(0);
 
  unsigned int SCM_iter=0;
  while (true)
    {
      // matrix_A is reinitialized for the current parameters
      // on each call to evaluate_stability_constant
      evaluate_stability_constant();
 
      std::pair<unsigned int,Real> SCM_error_pair = compute_SCM_bounds_on_training_set();
 
      libMesh::out << "SCM iteration " << SCM_iter
                   << ", max_SCM_error = " << SCM_error_pair.second << std::endl;
 
      if (SCM_error_pair.second < SCM_training_tolerance)
        {
          libMesh::out << std::endl << "SCM tolerance of " << SCM_training_tolerance << " reached."
                       << std::endl << std::endl;
          break;
        }
 
      // If we need another SCM iteration, then enrich C_J
      enrich_C_J(SCM_error_pair.first);
 
      libMesh::out << std::endl << "-----------------------------------" << std::endl << std::endl;
 
      SCM_iter++;
    }
}

References attach_deflation_space(), compute_SCM_bounding_box(), compute_SCM_bounds_on_training_set(), enrich_C_J(), evaluate_stability_constant(), libMesh::System::get_dof_map(), libMesh::System::get_equation_systems(), libMesh::EquationSystems::get_system(), libMesh::CondensedEigenSystem::initialize_condensed_dofs(), libMesh::RBParametrized::initialize_parameters(), libMesh::DofMap::is_constrained_dof(), load_matrix_B(), libMesh::System::n_dofs(), libMesh::out, rb_scm_eval, RB_system_name, and SCM_training_tolerance.

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

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

References libMesh::PointLocatorBase::enable_out_of_mesh_mode(), libMesh::libmesh_assert(), mesh, and libMesh::DofObject::processor_id().

Referenced by line_print().

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

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

References libMesh::Elem::contains_point(), dim, libMesh::Elem::dim(), libMesh::DofMap::dof_indices(), libMesh::FEComputeData::dshape, libMesh::FEComputeData::enable_derivative(), libMesh::NumericVector< T >::get(), libMesh::DofMap::is_evaluable(), libMesh::libmesh_assert(), libMesh::FEComputeData::local_transform, and libMesh::DofMap::variable_type().

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

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

References libMesh::libmesh_assert().

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

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

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

References libMesh::PointLocatorBase::enable_out_of_mesh_mode(), libMesh::libmesh_assert(), mesh, and libMesh::DofObject::processor_id().

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

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

References libMesh::TypeTensor< T >::add_scaled(), libMesh::Elem::contains_point(), libMesh::Elem::dim(), libMesh::DofMap::dof_indices(), libMesh::NumericVector< T >::get(), libMesh::Elem::infinite(), libMesh::DofMap::is_evaluable(), libMesh::libmesh_assert(), and libMesh::DofMap::variable_type().

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

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

References libMesh::libmesh_assert().

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

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

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

References libMesh::PointLocatorBase::enable_out_of_mesh_mode(), libMesh::libmesh_assert(), mesh, and libMesh::DofObject::processor_id().

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

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

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

References libMesh::Elem::contains_point(), libMesh::Elem::dim(), libMesh::DofMap::dof_indices(), libMesh::NumericVector< T >::get(), libMesh::DofMap::is_evaluable(), libMesh::libmesh_assert(), libMesh::FEComputeData::shape, and libMesh::DofMap::variable_type().

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

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

References libMesh::libmesh_assert().

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

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

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

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

Referenced by main().

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

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

References libMesh::System::name().

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

◆ prefix_with_name() [1/2]

bool libMesh::System::prefix_with_name ( ) const

inlineinherited

Returns: Whether we are name prefixing

Definition at line 1974 of file system.h.

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

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

◆ prefix_with_name() [2/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.

1969{ _prefix_with_name = value; }

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

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

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

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

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

◆ print_info() [1/3]

void libMesh::RBSCMConstruction::print_info ( )

virtual

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

Definition at line 161 of file rb_scm_construction.C.

{
  // Print out info that describes the current setup
  libMesh::out << std::endl << "RBSCMConstruction parameters:" << std::endl;
  libMesh::out << "system name: " << this->name() << std::endl;
  libMesh::out << "SCM Greedy tolerance: " << get_SCM_training_tolerance() << std::endl;
  if (rb_scm_eval)
    {
      libMesh::out << "A_q operators attached: " << get_rb_theta_expansion().get_n_A_terms() << std::endl;
    }
  else
    {
      libMesh::out << "RBThetaExpansion member is not set yet" << std::endl;
    }
  libMesh::out << "Number of parameters: " << get_n_params() << std::endl;
  for (const auto & pr : get_parameters())
    {
      const std::string & param_name = pr.first;
      libMesh::out <<   "Parameter " << param_name
                   << ": Min = " << get_parameter_min(param_name)
                   << ", Max = " << get_parameter_max(param_name) << std::endl;
    }
  print_discrete_parameter_values();
  libMesh::out << "n_training_samples: " << get_n_training_samples() << std::endl;
  libMesh::out << std::endl;
}

References libMesh::RBThetaExpansion::get_n_A_terms(), libMesh::RBParametrized::get_n_params(), libMesh::RBConstructionBase< CondensedEigenSystem >::get_n_training_samples(), libMesh::RBParametrized::get_parameter_max(), libMesh::RBParametrized::get_parameter_min(), libMesh::RBParametrized::get_parameters(), get_rb_theta_expansion(), get_SCM_training_tolerance(), libMesh::System::name(), libMesh::out, libMesh::RBParametrized::print_discrete_parameter_values(), and rb_scm_eval.

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

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

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

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

◆ print_info() [3/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.

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

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

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

◆ print_parameters()

void libMesh::RBParametrized::print_parameters ( ) const

inherited

Print the current parameters.

Definition at line 178 of file rb_parametrized.C.

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

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

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

◆ process_parameters_file()

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

virtual

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

Definition at line 89 of file rb_scm_construction.C.

{
  // First read in data from parameters_filename
  GetPot infile(parameters_filename);
  const unsigned int n_training_samples = infile("n_training_samples",1);
  const bool deterministic_training     = infile("deterministic_training",false);
 
  // 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.
  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);
  set_training_random_seed(static_cast<int>(training_parameters_random_seed_in));
 
  // SCM Greedy termination tolerance
  const Real SCM_training_tolerance_in = infile("SCM_training_tolerance", SCM_training_tolerance);
  set_SCM_training_tolerance(SCM_training_tolerance_in);
 
  // Initialize the parameter ranges and the parameters themselves
  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 (unsigned int j=0; j != n_vals_for_param; j++)
        vals_for_param[j] = infile(param_name, 0., j);
 
      discrete_parameter_values_in[param_name] = vals_for_param;
    }
 
  initialize_parameters(mu_min_in, mu_max_in, discrete_parameter_values_in);
 
  std::map<std::string,bool> log_scaling;
  const RBParameters & mu = get_parameters();
  unsigned int i=0;
  for (const auto & pr : mu)
    {
      const std::string & param_name = pr.first;
      log_scaling[param_name] = static_cast<bool>(infile("log_scaling", 0, i++));
    }
 
  initialize_training_parameters(this->get_parameters_min(),
                                 this->get_parameters_max(),
                                 n_training_samples,
                                 log_scaling,
                                 deterministic_training);   // use deterministic parameters
}

References libMesh::RBParametrized::get_parameters(), libMesh::RBParametrized::get_parameters_max(), libMesh::RBParametrized::get_parameters_min(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBConstructionBase< CondensedEigenSystem >::initialize_training_parameters(), libMesh::Real, SCM_training_tolerance, set_SCM_training_tolerance(), libMesh::RBConstructionBase< CondensedEigenSystem >::set_training_random_seed(), and libMesh::RBParameters::set_value().

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

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

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

◆ project_solution() [1/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 1080 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() [2/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 1065 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());
}

Referenced by init_sys(), initialize(), main(), set_initial_condition(), FETestBase< order, family, elem_type, build_nx, CaseName >::setUp(), SlitMeshRefinedSystemTest::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().

◆ 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 1049 of file system_projection.C.

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

References fptr(), and gptr().

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

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

References libMesh::System::_solution_projection.

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

◆ project_vector() [1/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, scalar_vars;
      for (auto var : vars)
      {
        if (this->variable(var).type().family == SCALAR)
          scalar_vars.push_back(var);
        else 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 : scalar_vars)
            {
              // 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
}

◆ project_vector() [2/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.

{
  // 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);
}

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

◆ project_vector() [3/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 1140 of file system_projection.C.

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

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

◆ project_vector() [4/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 1112 of file system_projection.C.

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

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

◆ project_vector() [5/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 1095 of file system_projection.C.

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

References fptr(), and gptr().

◆ 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 983 of file system_projection.C.

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

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

◆ prolong_vectors()

void libMesh::System::prolong_vectors ( )

virtualinherited

Prolong vectors after the mesh has refined.

Definition at line 432 of file system.C.

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

References libMesh::System::restrict_vectors().

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

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

{
  // 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);
}

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

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

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

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

◆ read_discrete_parameter_values_from_file()

void libMesh::RBParametrized::read_discrete_parameter_values_from_file	(	const std::string &	file_name,
		const bool	read_binary_data,
		std::map< std::string, std::vector< Real > > &	discrete_parameter_values_in
	)

privateinherited

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

Definition at line 318 of file rb_parametrized.C.

{
  // read in the discrete parameters, if we have any
  std::ifstream check_if_file_exists(file_name.c_str());
  if (check_if_file_exists.good())
    {
      // The reading mode: DECODE for binary, READ for ASCII
      XdrMODE mode = read_binary_data ? DECODE : READ;
 
      // Read in the parameter ranges
      Xdr discrete_parameter_values_in(file_name, mode);
      unsigned int n_discrete_params;
      discrete_parameter_values_in >> n_discrete_params;
 
      for (unsigned int i=0; i<n_discrete_params; i++)
        {
          std::string param_name;
          discrete_parameter_values_in >> param_name;
 
          unsigned int n_discrete_values;
          discrete_parameter_values_in >> n_discrete_values;
 
          std::vector<Real> discrete_values(n_discrete_values);
          for (auto & val : discrete_values)
            discrete_parameter_values_in >> val;
 
          discrete_parameter_values[param_name] = discrete_values;
        }
    }
}

References libMesh::DECODE, and libMesh::READ.

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

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

{
  // 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);
    }
}

References libMesh::System::_additional_data_written, libMesh::System::_written_var_indices, libMesh::System::add_variable(), libMesh::System::add_vector(), libMesh::Parallel::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().

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

{
  // 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");
}

References libMesh::System::_additional_data_written, libMesh::System::_vectors, libMesh::System::_written_var_indices, libMesh::Xdr::data(), 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, and libMesh::System::variable().

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

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

References libMesh::RBParametrized::initialize_parameters(), libMesh::RBParametrized::read_discrete_parameter_values_from_file(), and libMesh::RBParametrized::read_parameter_ranges_from_file().

Referenced by libMesh::RBEvaluation::legacy_read_offline_data_from_files(), and libMesh::RBSCMEvaluation::legacy_read_offline_data_from_files().

◆ read_parameter_ranges_from_file()

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

privateinherited

Read in the parameter ranges from file.

Initialize parameters to the "minimum" parameter values.

Definition at line 281 of file rb_parametrized.C.

{
  // The reading mode: DECODE for binary, READ for ASCII
  XdrMODE mode = read_binary_data ? DECODE : READ;
 
  // Read in the parameter ranges
  Xdr parameter_ranges_in(file_name, mode);
  unsigned int n_continuous_params;
  parameter_ranges_in >> n_continuous_params;
 
  for (unsigned int i=0; i<n_continuous_params; i++)
    {
      std::string param_name;
      Real param_value;
 
      parameter_ranges_in >> param_name;
      parameter_ranges_in >> param_value;
 
      param_min.set_value(param_name, param_value);
    }
  for (unsigned int i=0; i<n_continuous_params; i++)
    {
      std::string param_name;
      Real param_value;
 
      parameter_ranges_in >> param_name;
      parameter_ranges_in >> param_value;
 
      param_max.set_value(param_name, param_value);
    }
 
  parameter_ranges_in.close();
}

References libMesh::Xdr::close(), libMesh::DECODE, libMesh::READ, libMesh::Real, and libMesh::RBParameters::set_value().

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

◆ read_SCALAR_dofs()

unsigned int libMesh::System::read_SCALAR_dofs	(	const unsigned int	var,
		Xdr &	io,
		NumericVector< Number > *	vec
	)		const

privateinherited

Reads the SCALAR dofs from the stream io and assigns the values to the appropriate entries of vec.

Returns: The number of dofs read.

Reads data and discards it if vec is a null pointer.

Definition at line 939 of file system_io.C.

{
  unsigned int n_assigned_vals = 0; // the number of values assigned, this will be returned.
 
  // Processor 0 will read the block from the buffer stream and send it to the last processor
  const unsigned int n_SCALAR_dofs = this->variable(var).type().order.get_order();
  std::vector<Number> input_buffer(n_SCALAR_dofs);
  if (this->processor_id() == 0)
    io.data_stream(input_buffer.data(), n_SCALAR_dofs);
 
#ifdef LIBMESH_HAVE_MPI
  if (this->n_processors() > 1)
    {
      const Parallel::MessageTag val_tag = this->comm().get_unique_tag();
 
      // Post the receive on the last processor
      if (this->processor_id() == (this->n_processors()-1))
        this->comm().receive(0, input_buffer, val_tag);
 
      // Send the data to processor 0
      if (this->processor_id() == 0)
        this->comm().send(this->n_processors()-1, input_buffer, val_tag);
    }
#endif
 
  // Finally, set the SCALAR values
  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 i : index_range(SCALAR_dofs))
        {
          if (vec)
            vec->set (SCALAR_dofs[i], input_buffer[i]);
          ++n_assigned_vals;
        }
    }
 
  return n_assigned_vals;
}

References libMesh::ParallelObject::comm(), libMesh::Xdr::data_stream(), libMesh::System::get_dof_map(), libMesh::OrderWrapper::get_order(), libMesh::Parallel::Communicator::get_unique_tag(), libMesh::index_range(), libMesh::ParallelObject::n_processors(), libMesh::FEType::order, libMesh::ParallelObject::processor_id(), libMesh::Parallel::Communicator::receive(), libMesh::DofMap::SCALAR_dof_indices(), libMesh::Parallel::Communicator::send(), libMesh::NumericVector< T >::set(), libMesh::Variable::type(), and libMesh::System::variable().

Referenced by libMesh::System::read_serialized_vector(), and libMesh::System::read_serialized_vectors().

◆ read_serialized_blocked_dof_objects()

template<typename iterator_type , typename InValType >

std::size_t libMesh::System::read_serialized_blocked_dof_objects	(	const dof_id_type	n_objects,
		const iterator_type	begin,
		const iterator_type	end,
		const InValType	dummy,
		Xdr &	io,
		const std::vector< NumericVector< Number > * > &	vecs,
		const unsigned int	var_to_read = `libMesh::invalid_uint`
	)		const

privateinherited

Reads an input vector from the stream io and assigns the values to a set of DofObjects.

This method uses blocked input and is safe to call on a distributed memory-mesh. Unless otherwise specified, all variables are read.

If an entry in vecs is a null pointer, the corresponding data is read (incrementing the file read location) but discarded.

Definition at line 618 of file system_io.C.

{
  //-------------------------------------------------------
  // General order: (IO format 0.7.4 & greater)
  //
  // for (objects ...)
  //   for (vecs ....)
  //     for (vars ....)
  //       for (comps ...)
  //
  // where objects are nodes or elements, sorted to be
  // partition independent,
  // vecs are one or more *identically distributed* solution
  // coefficient vectors, vars are one or more variables
  // to write, and comps are all the components for said
  // vars on the object.
 
  // variables to read.  Unless specified otherwise, defaults to _written_var_indices.
  std::vector<unsigned int> vars_to_read (_written_var_indices);
 
  if (var_to_read != libMesh::invalid_uint)
    vars_to_read.assign({var_to_read});
 
  const unsigned int
    sys_num    = this->number(),
    num_vecs   = cast_int<unsigned int>(vecs.size());
  const dof_id_type
    io_blksize = cast_int<dof_id_type>(std::min(max_io_blksize, static_cast<std::size_t>(n_objs))),
    num_blks   = cast_int<unsigned int>(std::ceil(static_cast<double>(n_objs)/
                                                  static_cast<double>(io_blksize)));
 
  libmesh_assert_less_equal (_written_var_indices.size(), this->n_vars());
 
  std::size_t n_read_values=0;
 
  std::vector<std::vector<dof_id_type>> xfer_ids(num_blks);  // The global IDs and # of components for the local objects in all blocks
  std::vector<std::vector<Number>>      recv_vals(num_blks); // The raw values for the local objects in all blocks
  std::vector<Parallel::Request>
    id_requests(num_blks), val_requests(num_blks);
  std::vector<Parallel::MessageTag>
    id_tags(num_blks), val_tags(num_blks);
 
  // ------------------------------------------------------
  // First pass - count the number of objects in each block
  // traverse all the objects and figure out which block they
  // will ultimately live in.
  std::vector<std::size_t>
    xfer_ids_size  (num_blks,0),
    recv_vals_size (num_blks,0);
 
 
  for (iterator_type it=begin; it!=end; ++it)
    {
      const dof_id_type
        id    = (*it)->id(),
        block = id/io_blksize;
 
      libmesh_assert_less (block, num_blks);
 
      xfer_ids_size[block] += 2; // for each object, we send its id, as well as the total number of components for all variables
 
      dof_id_type n_comp_tot=0;
      for (const auto & var : vars_to_read)
        n_comp_tot += (*it)->n_comp(sys_num, var); // for each variable, we will receive the nonzero components
 
      recv_vals_size[block] += n_comp_tot*num_vecs;
    }
 
  // knowing the recv_vals_size[block] for each processor allows
  // us to sum them and find the global size for each block.
  std::vector<std::size_t> tot_vals_size(recv_vals_size);
  this->comm().sum (tot_vals_size);
 
 
  //------------------------------------------
  // Collect the ids & number of values needed
  // for all local objects, binning them into
  // 'blocks' that will be sent to processor 0
  for (dof_id_type blk=0; blk<num_blks; blk++)
    {
      // Each processor should build up its transfer buffers for its
      // local objects in [first_object,last_object).
      const dof_id_type
        first_object = blk*io_blksize,
        last_object  = std::min(cast_int<dof_id_type>((blk+1)*io_blksize), n_objs);
 
      // convenience
      std::vector<dof_id_type> & ids (xfer_ids[blk]);
      std::vector<Number> & vals (recv_vals[blk]);
 
      // we now know the number of values we will store for each block,
      // so we can do efficient preallocation
      ids.clear();  ids.reserve (xfer_ids_size[blk]);
      vals.resize(recv_vals_size[blk]);
 
#ifdef DEBUG
      std::unordered_set<dof_id_type> seen_ids;
#endif
 
      if (recv_vals_size[blk] != 0) // only if there are nonzero values to receive
        for (iterator_type it=begin; it!=end; ++it)
          {
            dof_id_type id = (*it)->id();
#ifdef DEBUG
            // Any renumbering tricks should not have given us any
            // duplicate ids.
            libmesh_assert(!seen_ids.count(id));
            seen_ids.insert(id);
#endif
 
            if ((id >= first_object) && // object in [first_object,last_object)
                (id <   last_object))
              {
                ids.push_back(id);
 
                unsigned int n_comp_tot=0;
 
                for (const auto & var : vars_to_read)
                  n_comp_tot += (*it)->n_comp(sys_num, var);
 
                ids.push_back (n_comp_tot*num_vecs);
              }
          }
 
#ifdef LIBMESH_HAVE_MPI
      id_tags[blk]  = this->comm().get_unique_tag(100*num_blks + blk);
      val_tags[blk] = this->comm().get_unique_tag(200*num_blks + blk);
 
      // nonblocking send the data for this block
      this->comm().send (0, ids,  id_requests[blk],  id_tags[blk]);
 
      // Go ahead and post the receive too
      this->comm().receive (0, vals, val_requests[blk], val_tags[blk]);
#endif
    }
 
  //---------------------------------------------------
  // Here processor 0 will read and distribute the data.
  // We have to do this block-wise to ensure that we
  // do not exhaust memory on processor 0.
 
  // give these variables scope outside the block to avoid reallocation
  std::vector<std::vector<dof_id_type>> recv_ids       (this->n_processors());
  std::vector<std::vector<Number>>      send_vals      (this->n_processors());
  std::vector<Parallel::Request>         reply_requests (this->n_processors());
  std::vector<unsigned int>              obj_val_offsets;          // map to traverse entry-wise rather than processor-wise
  std::vector<Number>                    input_vals;               // The input buffer for the current block
  std::vector<InValType>                 input_vals_tmp;               // The input buffer for the current block
 
  for (dof_id_type blk=0; blk<num_blks; blk++)
    {
      // Each processor should build up its transfer buffers for its
      // local objects in [first_object,last_object).
      const dof_id_type
        first_object  = blk*io_blksize,
        last_object   = std::min(cast_int<dof_id_type>((blk+1)*io_blksize), n_objs),
        n_objects_blk = last_object - first_object;
 
      // Processor 0 has a special job.  It needs to gather the requested indices
      // in [first_object,last_object) from all processors, read the data from
      // disk, and reply
      if (this->processor_id() == 0)
        {
          // we know the input buffer size for this block and can begin reading it now
          input_vals.resize(tot_vals_size[blk]);
          input_vals_tmp.resize(tot_vals_size[blk]);
 
          // a ThreadedIO object to perform asynchronous file IO
          ThreadedIO<InValType> threaded_io(io, input_vals_tmp);
          Threads::Thread async_io(threaded_io);
 
          // offset array. this will define where each object's values
          // map into the actual input_vals buffer.  this must get
          // 0-initialized because 0-component objects are not actually sent
          obj_val_offsets.resize (n_objects_blk);  std::fill (obj_val_offsets.begin(), obj_val_offsets.end(), 0);
          recv_vals_size.resize(this->n_processors()); // reuse this to count how many values are going to each processor
 
#ifndef NDEBUG
          std::size_t n_vals_blk = 0;
#endif
 
          // loop over all processors and process their index request
          for (processor_id_type comm_step=0, tnp=this->n_processors(); comm_step != tnp; ++comm_step)
            {
#ifdef LIBMESH_HAVE_MPI
              // blocking receive indices for this block, imposing no particular order on processor
              Parallel::Status id_status (this->comm().probe (Parallel::any_source, id_tags[blk]));
              std::vector<dof_id_type> & ids (recv_ids[id_status.source()]);
              std::size_t & n_vals_proc (recv_vals_size[id_status.source()]);
              this->comm().receive (id_status.source(), ids, id_tags[blk]);
#else
              // straight copy without MPI
              std::vector<dof_id_type> & ids (recv_ids[0]);
              std::size_t & n_vals_proc (recv_vals_size[0]);
              ids = xfer_ids[blk];
#endif
 
              n_vals_proc = 0;
 
              // note its possible we didn't receive values for objects in
              // this block if they have no components allocated.
              for (std::size_t idx=0, sz=ids.size(); idx<sz; idx+=2)
                {
                  const dof_id_type
                    local_idx          = ids[idx+0]-first_object,
                    n_vals_tot_allvecs = ids[idx+1];
 
                  libmesh_assert_less (local_idx, n_objects_blk);
 
                  obj_val_offsets[local_idx] = n_vals_tot_allvecs;
                  n_vals_proc += n_vals_tot_allvecs;
                }
 
#ifndef NDEBUG
              n_vals_blk += n_vals_proc;
#endif
            }
 
          // We need the offsets into the input_vals vector for each object.
          // fortunately, this is simply the partial sum of the total number
          // of components for each object
          std::partial_sum(obj_val_offsets.begin(), obj_val_offsets.end(),
                           obj_val_offsets.begin());
 
          libmesh_assert_equal_to (n_vals_blk, obj_val_offsets.back());
          libmesh_assert_equal_to (n_vals_blk, tot_vals_size[blk]);
 
          // Wait for read completion
          async_io.join();
          // now copy the values back to the main vector for transfer
          for (auto i_val : index_range(input_vals))
            input_vals[i_val] = input_vals_tmp[i_val];
 
          n_read_values += input_vals.size();
 
          // pack data replies for each processor
          for (auto proc : make_range(this->n_processors()))
            {
              const std::vector<dof_id_type> & ids (recv_ids[proc]);
              std::vector<Number> & vals (send_vals[proc]);
              const std::size_t & n_vals_proc (recv_vals_size[proc]);
 
              vals.clear();  vals.reserve(n_vals_proc);
 
              for (std::size_t idx=0, sz=ids.size(); idx<sz; idx+=2)
                {
                  const dof_id_type
                    local_idx          = ids[idx+0]-first_object,
                    n_vals_tot_allvecs = ids[idx+1];
 
                  std::vector<Number>::const_iterator in_vals(input_vals.begin());
                  if (local_idx != 0)
                    std::advance (in_vals, obj_val_offsets[local_idx-1]);
 
                  for (unsigned int val=0; val<n_vals_tot_allvecs; val++, ++in_vals)
                    {
                      libmesh_assert (in_vals != input_vals.end());
                      //libMesh::out << "*in_vals=" << *in_vals << '\n';
                      vals.push_back(*in_vals);
                    }
                }
 
#ifdef LIBMESH_HAVE_MPI
              // send the relevant values to this processor
              this->comm().send (proc, vals, reply_requests[proc], val_tags[blk]);
#else
              recv_vals[blk] = vals;
#endif
            }
        } // end processor 0 read/reply
 
      // all processors complete the (already posted) read for this block
      {
        Parallel::wait (val_requests[blk]);
 
        const std::vector<Number> & vals (recv_vals[blk]);
        std::vector<Number>::const_iterator val_it(vals.begin());
 
        if (!recv_vals[blk].empty()) // nonzero values to receive
          for (iterator_type it=begin; it!=end; ++it)
            if (((*it)->id() >= first_object) && // object in [first_object,last_object)
                ((*it)->id() <   last_object))
              // unpack & set the values
              for (auto & vec : vecs)
                for (const auto & var : vars_to_read)
                  {
                    const unsigned int n_comp = (*it)->n_comp(sys_num, var);
 
                    for (unsigned int comp=0; comp<n_comp; comp++, ++val_it)
                      {
                        const dof_id_type dof_index = (*it)->dof_number (sys_num, var, comp);
                        libmesh_assert (val_it != vals.end());
                        if (vec)
                          {
                            libmesh_assert_greater_equal (dof_index, vec->first_local_index());
                            libmesh_assert_less (dof_index, vec->last_local_index());
                            //libMesh::out << "dof_index, *val_it = \t" << dof_index << ", " << *val_it << '\n';
                            vec->set (dof_index, *val_it);
                          }
                      }
                  }
      }
 
      // processor 0 needs to make sure all replies have been handed off
      if (this->processor_id () == 0)
        Parallel::wait(reply_requests);
    }
 
  Parallel::wait(id_requests);
 
  return n_read_values;
}

References libMesh::System::_written_var_indices, TIMPI::any_source, libMesh::ParallelObject::comm(), libMesh::Parallel::Communicator::get_unique_tag(), libMesh::index_range(), libMesh::invalid_uint, libMesh::Threads::NonConcurrentThread::join(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::ParallelObject::n_processors(), libMesh::System::number(), libMesh::ParallelObject::processor_id(), libMesh::Parallel::Communicator::receive(), libMesh::Parallel::Communicator::send(), TIMPI::Status::source(), libMesh::Parallel::Communicator::sum(), and TIMPI::wait().

Referenced by libMesh::System::read_serialized_vector(), and libMesh::System::read_serialized_vectors().

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

{
  // 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");
}

References libMesh::System::_additional_data_written, libMesh::System::_vectors, libMesh::Xdr::comment(), libMesh::ParallelObject::processor_id(), and libMesh::System::solution.

Referenced by libMesh::TransientRBConstruction::initialize_truth(), libMesh::RBConstruction::read_riesz_representors_from_files(), and libMesh::TransientRBConstruction::read_riesz_representors_from_files().

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

numeric_index_type libMesh::System::read_serialized_vector	(	Xdr &	io,
		NumericVector< Number > &	vec
	)

inlineprivateinherited

Non-templated version for backward compatibility.

Reads a vector for this System. This method may safely be called on a distributed-memory mesh.

Returns: The length of the vector read.

Definition at line 2126 of file system.h.

2128 { return read_serialized_vector<Number>(io, &vec); }

◆ read_serialized_vector() [2/2]

template<typename InValType >

template LIBMESH_EXPORT numeric_index_type libMesh::System::read_serialized_vector< Real >	(	Xdr &	io,
		NumericVector< Number > *	vec
	)

privateinherited

Reads a vector for this System.

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

Returns: The length of the vector read.

Reads data and discards it if vec is a null pointer.

Definition at line 986 of file system_io.C.

{
  parallel_object_only();
 
#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 && vec)
    {
      libmesh_assert (vec->type() == PARALLEL ||
                      vec->type() == GHOSTED);
    }
#endif
 
  libmesh_assert (io.reading());
 
  // vector length
  unsigned int vector_length=0; // FIXME?  size_t would break binary compatibility...
#ifndef NDEBUG
  std::size_t n_assigned_vals=0;
#endif
 
  // Get the buffer size
  if (this->processor_id() == 0)
    io.data(vector_length, "# vector length");
  this->comm().broadcast(vector_length);
 
  const unsigned int nv = cast_int<unsigned int>
    (this->_written_var_indices.size());
  const dof_id_type
    n_nodes = this->get_mesh().n_nodes(),
    n_elem  = this->get_mesh().n_elem();
 
  libmesh_assert_less_equal (nv, this->n_vars());
 
  // for newer versions, read variables node/elem major
  if (io.version() >= LIBMESH_VERSION_ID(0,7,4))
    {
      //---------------------------------
      // Collect the values for all nodes
#ifndef NDEBUG
      n_assigned_vals +=
#endif
        this->read_serialized_blocked_dof_objects (n_nodes,
                                                   this->get_mesh().local_nodes_begin(),
                                                   this->get_mesh().local_nodes_end(),
                                                   InValType(),
                                                   io,
                                                   std::vector<NumericVector<Number> *> (1,vec));
 
 
      //------------------------------------
      // Collect the values for all elements
#ifndef NDEBUG
      n_assigned_vals +=
#endif
        this->read_serialized_blocked_dof_objects (n_elem,
                                                   this->get_mesh().local_elements_begin(),
                                                   this->get_mesh().local_elements_end(),
                                                   InValType(),
                                                   io,
                                                   std::vector<NumericVector<Number> *> (1,vec));
    }
 
  // for older versions, read variables var-major
  else
    {
      // Loop over each variable in the system, and then each node/element in the mesh.
      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)
            {
              //---------------------------------
              // Collect the values for all nodes
#ifndef NDEBUG
              n_assigned_vals +=
#endif
                this->read_serialized_blocked_dof_objects (n_nodes,
                                                           this->get_mesh().local_nodes_begin(),
                                                           this->get_mesh().local_nodes_end(),
                                                           InValType(),
                                                           io,
                                                           std::vector<NumericVector<Number> *> (1,vec),
                                                           var);
 
 
              //------------------------------------
              // Collect the values for all elements
#ifndef NDEBUG
              n_assigned_vals +=
#endif
                this->read_serialized_blocked_dof_objects (n_elem,
                                                           this->get_mesh().local_elements_begin(),
                                                           this->get_mesh().local_elements_end(),
                                                           InValType(),
                                                           io,
                                                           std::vector<NumericVector<Number> *> (1,vec),
                                                           var);
            } // end variable loop
        }
    }
 
  //-------------------------------------------
  // Finally loop over all the SCALAR variables
  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)
        {
#ifndef NDEBUG
          n_assigned_vals +=
#endif
            this->read_SCALAR_dofs (var, io, vec);
        }
    }
 
  if (vec)
    vec->close();
 
#ifndef NDEBUG
  this->comm().sum (n_assigned_vals);
  libmesh_assert_equal_to (n_assigned_vals, vector_length);
#endif
 
  return vector_length;
}

References libMesh::System::_written_var_indices, libMesh::Parallel::Communicator::broadcast(), libMesh::NumericVector< T >::close(), libMesh::ParallelObject::comm(), libMesh::Xdr::data(), libMesh::System::get_mesh(), libMesh::GHOSTED, libMesh::libmesh_assert(), libMesh::MeshBase::n_elem(), libMesh::MeshBase::n_nodes(), n_nodes, libMesh::ParallelObject::n_processors(), libMesh::System::n_vars(), libMesh::PARALLEL, libMesh::ParallelObject::processor_id(), libMesh::System::read_SCALAR_dofs(), libMesh::System::read_serialized_blocked_dof_objects(), libMesh::Xdr::reading(), libMesh::SCALAR, libMesh::Parallel::Communicator::sum(), libMesh::NumericVector< T >::type(), libMesh::System::variable(), and libMesh::Xdr::version().

◆ 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 2015 of file system_io.C.

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

References libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshBase::n_elem(), libMesh::MeshBase::n_nodes(), 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, libMesh::Variable::type(), and libMesh::System::variable().

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

◆ 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::CondensedEigenSystem::reinit ( )

overridevirtualinherited

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

Reimplemented from libMesh::EigenSystem.

Definition at line 83 of file condensed_eigen_system.C.

{
  Parent::reinit();
  _condensed_dofs_initialized = false;
}

References libMesh::CondensedEigenSystem::_condensed_dofs_initialized, and libMesh::EigenSystem::reinit().

Referenced by form_functionA(), form_functionB(), and form_matrixA().

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

{
  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();
}

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

◆ reinit_mesh()

void libMesh::System::reinit_mesh ( )

virtualinherited

Reinitializes the system with a new mesh.

Definition at line 289 of file system.C.

{
  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();
 
}

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

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

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

References libMesh::System::_matrices.

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

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

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

◆ request_matrix() [1/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.

{
  if (auto pos = _matrices.find(mat_name);
      pos != _matrices.end())
    return pos->second.get();
 
  // Otherwise, mat_name does not exist
  return nullptr;
}

References libMesh::System::_matrices.

◆ request_matrix() [2/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.

{
  if (const auto pos = _matrices.find(mat_name);
      pos != _matrices.end())
    return pos->second.get();
 
  // Otherwise, mat_name does not exist
  return nullptr;
}

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

◆ request_vector() [1/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.

{
  // 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();
}

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

◆ request_vector() [2/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.

{
  // 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();
}

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

◆ request_vector() [3/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.

{
  if (auto pos = _vectors.find(vec_name);
      pos != _vectors.end())
    return pos->second.get();
 
  // Otherwise, vec_name was not found
  return nullptr;
}

References libMesh::System::_vectors, and libMesh::NumericVector< T >::get().

◆ request_vector() [4/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.

{
  if (const auto pos = _vectors.find(vec_name);
      pos != _vectors.end())
    return pos->second.get();
 
  // Otherwise, vec_name was not found
  return nullptr;
}

References libMesh::System::_vectors, and libMesh::NumericVector< T >::get().

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

◆ resize_SCM_vectors()

void libMesh::RBSCMConstruction::resize_SCM_vectors ( )

virtual

Clear and resize the SCM data vectors.

Override in subclass as necessary.

Definition at line 188 of file rb_scm_construction.C.

{
  // Clear SCM data vectors
  rb_scm_eval->B_min.clear();
  rb_scm_eval->B_max.clear();
  rb_scm_eval->C_J.clear();
  rb_scm_eval->C_J_stability_vector.clear();
  for (auto & vec : rb_scm_eval->SCM_UB_vectors)
    vec.clear();
  rb_scm_eval->SCM_UB_vectors.clear();
 
  // Resize the bounding box vectors
  rb_scm_eval->B_min.resize(get_rb_theta_expansion().get_n_A_terms());
  rb_scm_eval->B_max.resize(get_rb_theta_expansion().get_n_A_terms());
}

References libMesh::RBSCMEvaluation::B_max, libMesh::RBSCMEvaluation::B_min, libMesh::RBSCMEvaluation::C_J, libMesh::RBSCMEvaluation::C_J_stability_vector, libMesh::RBThetaExpansion::get_n_A_terms(), get_rb_theta_expansion(), rb_scm_eval, and libMesh::RBSCMEvaluation::SCM_UB_vectors.

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

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

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

◆ SCM_greedy_error_indicator()

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

inlineprotectedvirtual

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

Override in subclasses to specialize behavior.

Definition at line 224 of file rb_scm_construction.h.

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

Referenced by compute_SCM_bounds_on_training_set().

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

418 { adjoint_already_solved = setting;}

References libMesh::System::adjoint_already_solved.

Referenced by main().

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

{
  _basic_system_only = true;
}

References libMesh::System::_basic_system_only.

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

◆ set_deterministic_training_parameter_name()

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

inherited

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

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

◆ set_eigenproblem_type()

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

inherited

Sets the type of the current eigen problem.

Definition at line 85 of file eigen_system.C.

{
  if (!can_add_matrices())
    libmesh_error_msg("ERROR: Cannot change eigen problem type after system initialization");
 
  _eigen_problem_type = ept;
 
  eigen_solver->set_eigenproblem_type(ept);
 
  // libMesh::out << "The Problem type is set to be: " << std::endl;
 
  switch (_eigen_problem_type)
    {
    case HEP:
      // libMesh::out << "Hermitian" << std::endl;
      break;
 
    case NHEP:
      // libMesh::out << "Non-Hermitian" << std::endl;
      break;
 
    case GHEP:
      // libMesh::out << "Generalized Hermitian" << std::endl;
      break;
 
    case GNHEP:
      // libMesh::out << "Generalized Non-Hermitian" << std::endl;
      break;
 
    case GHIEP:
      // libMesh::out << "Generalized indefinite Hermitian" << std::endl;
      break;
 
    default:
      // libMesh::out << "not properly specified" << std::endl;
      libmesh_error_msg("Unrecognized _eigen_problem_type = " << _eigen_problem_type);
    }
}

References libMesh::EigenSystem::_eigen_problem_type, libMesh::System::can_add_matrices(), libMesh::EigenSystem::eigen_solver, libMesh::GHEP, libMesh::GHIEP, libMesh::GNHEP, libMesh::HEP, and libMesh::NHEP.

Referenced by main(), and RBSCMConstruction().

◆ set_eigensolver_properties()

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

inlinevirtual

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

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

Definition at line 133 of file rb_scm_construction.h.

133{}

Referenced by compute_SCM_bounding_box(), and evaluate_stability_constant().

◆ set_initial_space()

void libMesh::EigenSystem::set_initial_space ( NumericVector< Number > & initial_space_in )

inherited

Sets an initial eigen vector.

Definition at line 319 of file eigen_system.C.

{
  eigen_solver->set_initial_space (initial_space_in);
}

References libMesh::EigenSystem::eigen_solver.

◆ set_n_converged()

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

inlineprotectedinherited

Set the _n_converged_eigenpairs member, useful for subclasses of EigenSystem.

Definition at line 381 of file eigen_system.h.

382 { _n_converged_eigenpairs = nconv; }

References libMesh::EigenSystem::_n_converged_eigenpairs.

◆ set_n_iterations()

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

inlineprotectedinherited

Set the _n_iterations member, useful for subclasses of EigenSystem.

Definition at line 388 of file eigen_system.h.

389 { _n_iterations = its;}

References libMesh::EigenSystem::_n_iterations.

◆ set_normalize_solution_snapshots()

void libMesh::RBConstructionBase< CondensedEigenSystem >::set_normalize_solution_snapshots ( bool value )

inherited

Set the boolean option that indicates if we normalization solution snapshots or not.

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

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

References libMesh::RBParametrized::check_if_valid_params(), libMesh::RBParametrized::parameters, and libMesh::RBParametrized::parameters_initialized.

Referenced by 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(), main(), libMesh::RBSCMEvaluation::reload_current_parameters(), libMesh::RBSCMEvaluation::set_current_parameters_from_C_J(), and RBParametersTest::testRBParametrized().

◆ set_params_from_training_set()

void libMesh::RBConstructionBase< CondensedEigenSystem >::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 243 of file rb_construction_base.C.

{
  set_parameters(get_params_from_training_set(global_index));
}

◆ set_params_from_training_set_and_broadcast()

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

  {
    project_with_constraints = _project_with_constraints;
  }

References libMesh::System::project_with_constraints.

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

◆ set_qoi() [1/2]

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

inherited

Definition at line 2197 of file system.C.

{
  libmesh_assert_equal_to(this->_qoi.size(), new_qoi.size());
  this->_qoi = std::move(new_qoi);
}

◆ set_qoi() [2/2]

void libMesh::System::set_qoi	(	unsigned int	qoi_index,
		Number	qoi_value
	)

inherited

Definition at line 2176 of file system.C.

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

References libMesh::libmesh_assert().

Referenced by libMesh::FEMSystem::assemble_qoi(), libMesh::ExplicitSystem::assemble_qoi(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), and libMesh::TwostepTimeSolver::integrate_qoi_timestep().

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

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

References libMesh::libmesh_assert().

Referenced by libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::SteadySolver::integrate_adjoint_refinement_error_estimate(), and libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate().

◆ set_quiet_mode()

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

101 { this->quiet_mode = quiet_mode_in; }

◆ set_rb_scm_evaluation()

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

Set the RBSCMEvaluation object.

Definition at line 72 of file rb_scm_construction.C.

{
  rb_scm_eval = &rb_scm_eval_in;
}

References rb_scm_eval.

◆ set_RB_system_name()

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

inline

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

Definition at line 139 of file rb_scm_construction.h.

140 { RB_system_name = new_name; }

References RB_system_name.

Referenced by main().

◆ set_SCM_training_tolerance()

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

inline

Definition at line 146 of file rb_scm_construction.h.

146{ this->SCM_training_tolerance = SCM_training_tolerance_in; }

References SCM_training_tolerance.

Referenced by process_parameters_file().

◆ set_training_parameter_values()

void libMesh::RBConstructionBase< CondensedEigenSystem >::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 158 of file rb_construction_base.C.

{
  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< CondensedEigenSystem >::set_training_random_seed ( int seed )

inherited

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

Definition at line 170 of file rb_construction_base.C.

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

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

References libMesh::System::_vector_is_adjoint.

Referenced by libMesh::System::add_adjoint_solution(), and libMesh::System::add_weighted_sensitivity_adjoint_solution().

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

{
  parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
  _vector_projections[vec_name] = preserve;
}

References libMesh::System::_vector_projections.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and main().

◆ solve()

void libMesh::CondensedEigenSystem::solve ( )

overridevirtualinherited

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

Reimplemented from libMesh::EigenSystem.

Definition at line 164 of file condensed_eigen_system.C.

{
  LOG_SCOPE("solve()", "CondensedEigenSystem");
 
  // If we haven't initialized any condensed dofs,
  // just use the default eigen_system
  if (!_have_condensed_dofs)
    {
      Parent::solve();
      return;
    }
 
  // check that necessary parameters have been set
  libmesh_assert(
      this->get_equation_systems().parameters.have_parameter<unsigned int>("eigenpairs"));
  libmesh_assert(
      this->get_equation_systems().parameters.have_parameter<unsigned int>("basis vectors"));
 
  if (this->assemble_before_solve)
    {
      // Assemble the linear system
      this->assemble();
 
      // And close the assembled matrices; using a non-closed matrix
      // with create_submatrix() is deprecated.
      if (matrix_A)
        matrix_A->close();
      if (generalized() && matrix_B)
        matrix_B->close();
      if (precond_matrix)
        precond_matrix->close();
    }
 
  // If we reach here, then there should be some non-condensed dofs
  libmesh_assert(!local_non_condensed_dofs_vector.empty());
 
  if (_create_submatrices_in_solve)
    {
      if (matrix_A)
        matrix_A->create_submatrix(
            *_condensed_matrix_A, local_non_condensed_dofs_vector, local_non_condensed_dofs_vector);
      if (generalized() && matrix_B)
        matrix_B->create_submatrix(
            *_condensed_matrix_B, local_non_condensed_dofs_vector, local_non_condensed_dofs_vector);
      if (precond_matrix)
        precond_matrix->create_submatrix(*_condensed_precond_matrix,
                                         local_non_condensed_dofs_vector,
                                         local_non_condensed_dofs_vector);
    }
 
  solve_helper(
      _condensed_matrix_A.get(), _condensed_matrix_B.get(), _condensed_precond_matrix.get());
}

References libMesh::CondensedEigenSystem::_condensed_matrix_A, libMesh::CondensedEigenSystem::_condensed_matrix_B, libMesh::CondensedEigenSystem::_condensed_precond_matrix, libMesh::CondensedEigenSystem::_create_submatrices_in_solve, libMesh::CondensedEigenSystem::_have_condensed_dofs, libMesh::System::assemble(), libMesh::System::assemble_before_solve, libMesh::SparseMatrix< T >::close(), libMesh::SparseMatrix< T >::create_submatrix(), libMesh::EigenSystem::generalized(), libMesh::System::get_equation_systems(), libMesh::Parameters::have_parameter(), libMesh::libmesh_assert(), libMesh::CondensedEigenSystem::local_non_condensed_dofs_vector, libMesh::EigenSystem::matrix_A, libMesh::EigenSystem::matrix_B, libMesh::System::parameters, libMesh::EigenSystem::precond_matrix, libMesh::EigenSystem::solve(), and libMesh::EigenSystem::solve_helper().

Referenced by compute_SCM_bounding_box(), evaluate_stability_constant(), and main().

◆ solve_for_unconstrained_dofs()

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

inherited

Definition at line 2103 of file system_projection.C.

{
  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"));
}

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

◆ solve_helper()

void libMesh::EigenSystem::solve_helper	(	SparseMatrix< Number > *const	A,
		SparseMatrix< Number > *const	B,
		SparseMatrix< Number > *const	P
	)

protectedinherited

Definition at line 215 of file eigen_system.C.

{
  // A reference to the EquationSystems
  EquationSystems & es = this->get_equation_systems();
 
  // Get the tolerance for the solver and the maximum
  // number of iterations. Here, we simply adopt the linear solver
  // specific parameters.
  const double tol          =  parameters.have_parameter<Real>("linear solver tolerance") ?
    double(parameters.get<Real>("linear solver tolerance")) :
    double(es.parameters.get<Real>("linear solver tolerance"));
 
  const unsigned int maxits = parameters.have_parameter<unsigned int>("linear solver maximum iterations") ?
    parameters.get<unsigned int>("linear solver maximum iterations") :
    es.parameters.get<unsigned int>("linear solver maximum iterations");
 
  const unsigned int nev    = parameters.have_parameter<unsigned int>("eigenpairs") ?
    parameters.get<unsigned int>("eigenpairs") :
    es.parameters.get<unsigned int>("eigenpairs");
 
  const unsigned int ncv    = parameters.have_parameter<unsigned int>("basis vectors") ?
    parameters.get<unsigned int>("basis vectors") :
    es.parameters.get<unsigned int>("basis vectors");
 
  std::pair<unsigned int, unsigned int> solve_data;
 
  // call the solver depending on the type of eigenproblem
 
  if (_use_shell_matrices)
  {
    // Generalized eigenproblem
    if (generalized())
      // Shell preconditioning matrix
      if (_use_shell_precond_matrix)
        solve_data = eigen_solver->solve_generalized(
            *shell_matrix_A, *shell_matrix_B, *shell_precond_matrix, nev, ncv, tol, maxits);
      else
        solve_data = eigen_solver->solve_generalized(
            *shell_matrix_A, *shell_matrix_B, *P, nev, ncv, tol, maxits);
 
    // Standard eigenproblem
    else
    {
      libmesh_assert(!shell_matrix_B);
      // Shell preconditioning matrix
      if (_use_shell_precond_matrix)
        solve_data = eigen_solver->solve_standard(
            *shell_matrix_A, *shell_precond_matrix, nev, ncv, tol, maxits);
      else
        solve_data = eigen_solver->solve_standard(*shell_matrix_A, *P, nev, ncv, tol, maxits);
    }
  }
  else
  {
    // Generalized eigenproblem
    if (generalized())
      solve_data = eigen_solver->solve_generalized(*A, *B, nev, ncv, tol, maxits);
 
    // Standard eigenproblem
    else
    {
      libmesh_assert(!matrix_B);
      solve_data = eigen_solver->solve_standard(*A, nev, ncv, tol, maxits);
    }
  }
 
  this->_n_converged_eigenpairs = solve_data.first;
  this->_n_iterations           = solve_data.second;
}

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

◆ system()

sys_type & libMesh::RBConstructionBase< CondensedEigenSystem >::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::EigenSystem::system_type ( ) const

inlineoverridevirtualinherited

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

Reimplemented from libMesh::System.

Definition at line 125 of file eigen_system.h.

125{ return "Eigen"; }

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

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

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(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), LinearElasticityWithContact::compute_stresses(), compute_stresses(), libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_scalar_solution(), libMesh::Nemesis_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::NewtonSolver::line_search(), libMesh::RBConstruction::load_basis_function(), libMesh::RBConstruction::load_rb_solution(), libMesh::TransientRBConstruction::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::FileSolutionHistory::retrieve(), libMesh::MemorySolutionHistory::retrieve(), ParsedFEMFunctionTest::setUp(), libMesh::NewtonSolver::solve(), libMesh::ExplicitSystem::solve(), libMesh::LinearImplicitSystem::solve(), libMesh::NonlinearImplicitSystem::solve(), libMesh::OptimizationSystem::solve(), libMesh::ClawSystem::solve_conservation_law(), libMesh::RBConstruction::solve_for_matrix_and_rhs(), libMesh::DirectSolutionTransfer::transfer(), libMesh::MeshFunctionSolutionTransfer::transfer(), and update_current_local_solution().

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

{
  parallel_object_only();
 
  global_soln.resize (solution->size());
 
  solution->localize (global_soln);
}

References libMesh::System::solution.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::ExactErrorEstimator::estimate_error(), main(), and libMesh::InterMeshProjection::project_system_vectors().

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

{
  parallel_object_only();
 
  global_soln.resize        (solution->size());
 
  solution->localize_to_one (global_soln, dest_proc);
}

References libMesh::System::solution.

◆ use_shell_matrices() [1/2]

bool libMesh::EigenSystem::use_shell_matrices ( ) const

inlineinherited

Returns: true if the shell matrices are used

Definition at line 161 of file eigen_system.h.

161{ return _use_shell_matrices; }

References libMesh::EigenSystem::_use_shell_matrices.

Referenced by libMesh::CondensedEigenSystem::add_matrices().

◆ use_shell_matrices() [2/2]

void libMesh::EigenSystem::use_shell_matrices ( bool use_shell_matrices )

inlineinherited

Set a flag to use shell matrices.

Definition at line 166 of file eigen_system.h.

166{ _use_shell_matrices = use_shell_matrices; }

References libMesh::EigenSystem::_use_shell_matrices, and libMesh::EigenSystem::use_shell_matrices().

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

◆ use_shell_precond_matrix() [1/2]

bool libMesh::EigenSystem::use_shell_precond_matrix ( ) const

inlineinherited

Returns: true if a shell preconditioning matrix is used

Definition at line 171 of file eigen_system.h.

171{ return _use_shell_precond_matrix; }

References libMesh::EigenSystem::_use_shell_precond_matrix.

Referenced by libMesh::CondensedEigenSystem::add_matrices().

◆ use_shell_precond_matrix() [2/2]

void libMesh::EigenSystem::use_shell_precond_matrix ( bool use_shell_precond_matrix )

inlineinherited

Set a flag to use a shell preconditioning matrix.

Definition at line 176 of file eigen_system.h.

176{ _use_shell_precond_matrix = use_shell_precond_matrix; }

References libMesh::EigenSystem::_use_shell_precond_matrix, and libMesh::EigenSystem::use_shell_precond_matrix().

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

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

{
  // 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();
}

Referenced by libMesh::System::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.

{
  // 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();
}

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

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

{
  // 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();
}

Referenced by libMesh::NewmarkSystem::initial_conditions(), and libMesh::System::reinit_mesh().

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

{
  // 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);
}

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

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

{
  // 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);
}

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

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

{
  return this->get_dof_map().variable(i);
}

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::PetscDMWrapper::add_dofs_to_section(), libMesh::DifferentiableSystem::add_second_order_dot_vars(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::DifferentiableSystem::have_first_order_scalar_vars(), libMesh::DifferentiableSystem::have_second_order_scalar_vars(), main(), main(), libMesh::DifferentiablePhysics::nonlocal_mass_residual(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::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::System::read_parallel_data(), libMesh::System::read_SCALAR_dofs(), libMesh::System::read_serialized_vector(), libMesh::System::read_serialized_vectors(), libMesh::PetscPreconditioner< T >::set_petsc_aux_data(), libMesh::PetscDMWrapper::set_point_range_in_section(), SystemsTest::testFirstScalarNumber(), libMesh::System::write_header(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), libMesh::System::write_parallel_data(), libMesh::System::write_serialized_vector(), and libMesh::System::write_serialized_vectors().

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

{
  return this->get_dof_map().variable_group(vg);
}

Referenced by libMesh::FEMSystem::assembly().

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

{
  return this->get_dof_map().variable_name(i);
}

Referenced by libMesh::PetscDMWrapper::build_section(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::ExactSolution::ExactSolution(), libMesh::EquationSystems::find_variable_numbers_by_predicate(), 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().

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

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

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(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), LinearElasticityWithContact::compute_stresses(), compute_stresses(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::ExactErrorEstimator::estimate_error(), fe_assembly(), libMesh::ExactErrorEstimator::find_squared_element_error(), AssemblyPointLoadX::get_nodal_rhs_values(), AssemblyPointLoadY::get_nodal_rhs_values(), AssemblyPointLoadZ::get_nodal_rhs_values(), CoupledSystemQoI::init_context(), LargeDeformationElasticity::jacobian(), libMesh::HDGProblem::jacobian(), line_print(), main(), LinearElasticityWithContact::move_mesh(), OverlappingCouplingFunctor::operator()(), libMesh::System::read_header(), LargeDeformationElasticity::residual(), libMesh::HDGProblem::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().

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

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

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

Referenced by libMesh::ExodusII_IO::copy_scalar_solution(), libMesh::Nemesis_IO::copy_scalar_solution(), libMesh::ExactErrorEstimator::find_squared_element_error(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::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()(), and libMesh::System::variable_scalar_number().

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

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

{
  return this->get_dof_map().variable_type(i);
}

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_shell(), assemble_stokes(), libMesh::FEMContext::attach_quadrature_rules(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::ExactSolution::compute_error(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::DGFEMContext::DGFEMContext(), libMesh::JumpErrorEstimator::estimate_error(), fe_assembly(), libMesh::FEMContext::find_hardest_fe_type(), libMesh::EquationSystems::find_variable_numbers_by_predicate(), form_functionA(), form_functionB(), form_matrixA(), libMesh::FEMSystem::init_context(), libMesh::FEMContext::init_internal_data(), OverlappingCouplingFunctor::operator()(), RationalMapTest< elem_type >::setUp(), FETestBase< order, family, elem_type, build_nx, CaseName >::setUp(), EquationSystemsTest::testBadVarNames(), FETest< order, family, elem_type, CaseName >::testCustomReinit(), FETest< order, family, elem_type, CaseName >::testFEInterface(), 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().

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

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

{
  const auto it = _vector_is_adjoint.find(vec_name);
  libmesh_assert(it != _vector_is_adjoint.end());
  return it->second;
}

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

Referenced by libMesh::InterMeshProjection::project_system_vectors(), and libMesh::System::restrict_vectors().

◆ vector_name() [1/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.

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

References libMesh::System::_vectors, libMesh::NumericVector< T >::get(), libMesh::libmesh_assert(), libMesh::System::vectors_begin(), and libMesh::System::vectors_end().

◆ vector_name() [2/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.

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

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

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and main().

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

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

References libMesh::System::_vector_projections.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::MemoryHistoryData::store_vectors(), SystemsTest::testAddVectorProjChange(), SystemsTest::testAddVectorTypeChange(), and SystemsTest::testPostInitAddVectorTypeChange().

◆ vectors_begin() [1/2]

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

inlineinherited

Beginning of vectors container.

Definition at line 2505 of file system.h.

{
  return _vectors.begin();
}

References libMesh::System::_vectors.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::System::get_vector(), libMesh::System::get_vector(), libMesh::InterMeshProjection::project_system_vectors(), libMesh::System::request_vector(), libMesh::System::request_vector(), libMesh::MemoryHistoryData::store_vectors(), libMesh::System::vector_name(), and libMesh::System::vector_name().

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

{
  return _vectors.begin();
}

References libMesh::System::_vectors.

◆ vectors_end() [1/2]

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

inlineinherited

End of vectors container.

Definition at line 2517 of file system.h.

{
  return _vectors.end();
}

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

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

{
  return _vectors.end();
}

References libMesh::System::_vectors.

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

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

privateinherited

Write out the discrete parameter values to file.

Definition at line 230 of file rb_parametrized.C.

{
  // write out the discrete parameters, if we have any
  if (get_n_discrete_params() > 0)
    {
      // The writing mode: ENCODE for binary, WRITE for ASCII
      XdrMODE mode = write_binary_data ? ENCODE : WRITE;
 
      Xdr discrete_parameters_out(file_name, mode);
      unsigned int n_discrete_params = get_n_discrete_params();
      discrete_parameters_out << n_discrete_params;
 
      // Note: the following loops are not candidates for structured
      // bindings syntax because the Xdr APIs which they call are not
      // defined for const references. We must therefore make copies
      // to call these functions.
      for (const auto & pr : get_discrete_parameter_values())
        {
          std::string param_name = pr.first;
          auto n_discrete_values = cast_int<unsigned int>(pr.second.size());
          discrete_parameters_out << param_name << n_discrete_values;
 
          for (unsigned int i=0; i<n_discrete_values; i++)
            {
              Real discrete_value = pr.second[i];
              discrete_parameters_out << discrete_value;
            }
        }
    }
}

References libMesh::ENCODE, libMesh::RBParametrized::get_discrete_parameter_values(), libMesh::RBParametrized::get_n_discrete_params(), libMesh::Real, and libMesh::WRITE.

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

◆ 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 1117 of file system_io.C.

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

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

◆ 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 1318 of file system_io.C.

{
  // 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");
}

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

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

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

References libMesh::RBParametrized::write_discrete_parameter_values_to_file(), and libMesh::RBParametrized::write_parameter_ranges_to_file().

Referenced by libMesh::RBEvaluation::legacy_write_offline_data_to_files(), and libMesh::RBSCMEvaluation::legacy_write_offline_data_to_files().

◆ write_parameter_ranges_to_file()

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

privateinherited

Write out the parameter ranges to file.

Definition at line 193 of file rb_parametrized.C.

{
  // The writing mode: ENCODE for binary, WRITE for ASCII
  XdrMODE mode = write_binary_data ? ENCODE : WRITE;
 
  // Write out the parameter ranges
  Xdr parameter_ranges_out(file_name, mode);
  unsigned int n_continuous_params = get_n_continuous_params();
  parameter_ranges_out << n_continuous_params;
 
  // Note: the following loops are not candidates for structured
  // bindings syntax because the Xdr APIs which they call are not
  // defined for const references. We must therefore make copies to
  // call these functions.
  for (const auto & pr : get_parameters_min())
    {
      std::string param_name = pr.first;
      if (!is_discrete_parameter(param_name))
        {
          Real param_value = get_parameters_min().get_value(param_name);
          parameter_ranges_out << param_name << param_value;
        }
    }
  for (const auto & pr : get_parameters_max())
    {
      std::string param_name = pr.first;
      if (!is_discrete_parameter(param_name))
        {
          Real param_value = get_parameters_max().get_value(param_name);
          parameter_ranges_out << param_name << param_value;
        }
    }
 
  parameter_ranges_out.close();
}

References libMesh::Xdr::close(), libMesh::ENCODE, libMesh::RBParametrized::get_n_continuous_params(), libMesh::RBParametrized::get_parameters_max(), libMesh::RBParametrized::get_parameters_min(), libMesh::RBParameters::get_value(), libMesh::RBParametrized::is_discrete_parameter(), libMesh::Real, and libMesh::WRITE.

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

◆ write_SCALAR_dofs()

unsigned int libMesh::System::write_SCALAR_dofs	(	const NumericVector< Number > &	vec,
		const unsigned int	var,
		Xdr &	io
	)		const

privateinherited

Writes the SCALAR dofs associated with var to the stream io.

Returns: The number of values written.

Definition at line 1912 of file system_io.C.

{
  unsigned int written_length=0;
  std::vector<Number> vals; // The raw values for the local objects in the current block
  // Collect the SCALARs for the current variable
  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);
      const unsigned int n_scalar_dofs = cast_int<unsigned int>
        (SCALAR_dofs.size());
 
      for (unsigned int i=0; i<n_scalar_dofs; i++)
        {
          vals.push_back( vec(SCALAR_dofs[i]) );
        }
    }
 
#ifdef LIBMESH_HAVE_MPI
  if (this->n_processors() > 1)
    {
      const Parallel::MessageTag val_tag =
        this->comm().get_unique_tag(1);
 
      // Post the receive on processor 0
      if (this->processor_id() == 0)
        {
          this->comm().receive(this->n_processors()-1, vals, val_tag);
        }
 
      // Send the data to processor 0
      if (this->processor_id() == (this->n_processors()-1))
        {
          this->comm().send(0, vals, val_tag);
        }
    }
#endif
 
  // -------------------------------------------------------
  // Write the output on processor 0.
  if (this->processor_id() == 0)
    {
      const unsigned int vals_size =
        cast_int<unsigned int>(vals.size());
      io.data_stream (vals.data(), vals_size);
      written_length += vals_size;
    }
 
  return written_length;
}

References libMesh::ParallelObject::comm(), libMesh::Xdr::data_stream(), libMesh::System::get_dof_map(), libMesh::Parallel::Communicator::get_unique_tag(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::processor_id(), libMesh::Parallel::Communicator::receive(), libMesh::DofMap::SCALAR_dof_indices(), and libMesh::Parallel::Communicator::send().

Referenced by libMesh::System::write_serialized_vector(), and libMesh::System::write_serialized_vectors().

◆ write_serialized_blocked_dof_objects()

template<typename iterator_type >

std::size_t libMesh::System::write_serialized_blocked_dof_objects	(	const std::vector< const NumericVector< Number > * > &	vecs,
		const dof_id_type	n_objects,
		const iterator_type	begin,
		const iterator_type	end,
		Xdr &	io,
		const unsigned int	var_to_write = `libMesh::invalid_uint`
	)		const

privateinherited

Writes an output vector to the stream io for a set of DofObjects.

This method uses blocked output and is safe to call on a distributed memory-mesh.

Returns: The number of values written

Definition at line 1626 of file system_io.C.

{
  parallel_object_only();
 
  //-------------------------------------------------------
  // General order: (IO format 0.7.4 & greater)
  //
  // for (objects ...)
  //   for (vecs ....)
  //     for (vars ....)
  //       for (comps ...)
  //
  // where objects are nodes or elements, sorted to be
  // partition independent,
  // vecs are one or more *identically distributed* solution
  // coefficient vectors, vars are one or more variables
  // to write, and comps are all the components for said
  // vars on the object.
 
  // We will write all variables unless requested otherwise.
  std::vector<unsigned int> vars_to_write(1, var_to_write);
 
  if (var_to_write == libMesh::invalid_uint)
    {
      vars_to_write.clear();  vars_to_write.reserve(this->n_vars());
      for (auto var : make_range(this->n_vars()))
        vars_to_write.push_back(var);
    }
 
  const dof_id_type io_blksize = cast_int<dof_id_type>
    (std::min(max_io_blksize, static_cast<std::size_t>(n_objs)));
 
  const unsigned int
    sys_num  = this->number(),
    num_vecs = cast_int<unsigned int>(vecs.size()),
    num_blks = cast_int<unsigned int>(std::ceil(static_cast<double>(n_objs)/
                                                static_cast<double>(io_blksize)));
 
  // libMesh::out << "io_blksize = "    << io_blksize
  //     << ", num_objects = " << n_objs
  //     << ", num_blks = "    << num_blks
  //     << std::endl;
 
  std::size_t written_length=0;                                  // The numer of values written.  This will be returned
  std::vector<std::vector<dof_id_type>> xfer_ids(num_blks);      // The global IDs and # of components for the local objects in all blocks
  std::vector<std::vector<Number>>      send_vals(num_blks);     // The raw values for the local objects in all blocks
  std::vector<Parallel::Request>
    id_requests(num_blks), val_requests(num_blks);               // send request handle for each block
  std::vector<Parallel::MessageTag>
    id_tags(num_blks), val_tags(num_blks);                       // tag number for each block
 
  // ------------------------------------------------------
  // First pass - count the number of objects in each block
  // traverse all the objects and figure out which block they
  // will ultimately live in.
  std::vector<unsigned int>
    xfer_ids_size  (num_blks,0),
    send_vals_size (num_blks,0);
 
  for (iterator_type it=begin; it!=end; ++it)
    {
      const dof_id_type
        id    = (*it)->id(),
        block = id/io_blksize;
 
      libmesh_assert_less (block, num_blks);
 
      xfer_ids_size[block] += 2; // for each object, we store its id, as well as the total number of components for all variables
 
      unsigned int n_comp_tot=0;
 
      for (const auto & var : vars_to_write)
        n_comp_tot += (*it)->n_comp(sys_num, var); // for each variable, we will store the nonzero components
 
      send_vals_size[block] += n_comp_tot*num_vecs;
    }
 
  //-----------------------------------------
  // Collect the values for all local objects,
  // binning them into 'blocks' that will be
  // sent to processor 0
  for (unsigned int blk=0; blk<num_blks; blk++)
    {
      // libMesh::out << "Writing object block " << blk << std::endl;
 
      // Each processor should build up its transfer buffers for its
      // local objects in [first_object,last_object).
      const dof_id_type
        first_object = blk*io_blksize,
        last_object  = std::min(cast_int<dof_id_type>((blk+1)*io_blksize), n_objs);
 
      // convenience
      std::vector<dof_id_type> & ids  (xfer_ids[blk]);
      std::vector<Number>      & vals (send_vals[blk]);
 
      // we now know the number of values we will store for each block,
      // so we can do efficient preallocation
      ids.clear();   ids.reserve  (xfer_ids_size[blk]);
      vals.clear();  vals.reserve (send_vals_size[blk]);
 
      if (send_vals_size[blk] != 0) // only send if we have nonzero components to write
        for (iterator_type it=begin; it!=end; ++it)
          if (((*it)->id() >= first_object) && // object in [first_object,last_object)
              ((*it)->id() <   last_object))
            {
              ids.push_back((*it)->id());
 
              // count the total number of nonzeros transferred for this object
              {
                unsigned int n_comp_tot=0;
 
                for (const auto & var : vars_to_write)
                  n_comp_tot += (*it)->n_comp(sys_num, var);
 
                ids.push_back (n_comp_tot*num_vecs); // even if 0 - processor 0 has no way of knowing otherwise...
              }
 
              // pack the values to send
              for (const auto & vec : vecs)
                for (const auto & var : vars_to_write)
                  {
                    const unsigned int n_comp = (*it)->n_comp(sys_num, var);
 
                    for (unsigned int comp=0; comp<n_comp; comp++)
                      {
                        libmesh_assert_greater_equal ((*it)->dof_number(sys_num, var, comp), vec->first_local_index());
                        libmesh_assert_less ((*it)->dof_number(sys_num, var, comp), vec->last_local_index());
                        vals.push_back((*vec)((*it)->dof_number(sys_num, var, comp)));
                      }
                  }
            }
 
#ifdef LIBMESH_HAVE_MPI
      id_tags[blk]  = this->comm().get_unique_tag(100*num_blks + blk);
      val_tags[blk] = this->comm().get_unique_tag(200*num_blks + blk);
 
      // nonblocking send the data for this block
      this->comm().send (0, ids,  id_requests[blk],  id_tags[blk]);
      this->comm().send (0, vals, val_requests[blk], val_tags[blk]);
#endif
    }
 
 
  if (this->processor_id() == 0)
    {
      std::vector<std::vector<dof_id_type>> recv_ids  (this->n_processors());
      std::vector<std::vector<Number>>      recv_vals (this->n_processors());
      std::vector<unsigned int> obj_val_offsets;          // map to traverse entry-wise rather than processor-wise
      std::vector<Number>       output_vals;              // The output buffer for the current block
 
      // a ThreadedIO object to perform asynchronous file IO
      ThreadedIO<Number> threaded_io(io, output_vals);
      std::unique_ptr<Threads::Thread> async_io;
 
      for (unsigned int blk=0; blk<num_blks; blk++)
        {
          // Each processor should build up its transfer buffers for its
          // local objects in [first_object,last_object).
          const dof_id_type
            first_object  = cast_int<dof_id_type>(blk*io_blksize),
            last_object   = std::min(cast_int<dof_id_type>((blk+1)*io_blksize), n_objs),
            n_objects_blk = last_object - first_object;
 
          // offset array. this will define where each object's values
          // map into the actual output_vals buffer.  this must get
          // 0-initialized because 0-component objects are not actually sent
          obj_val_offsets.resize (n_objects_blk);  std::fill (obj_val_offsets.begin(), obj_val_offsets.end(), 0);
 
          std::size_t n_val_recvd_blk=0;
 
          // receive this block of data from all processors.
          for (processor_id_type comm_step=0, tnp=this->n_processors(); comm_step != tnp; ++comm_step)
            {
#ifdef LIBMESH_HAVE_MPI
              // blocking receive indices for this block, imposing no particular order on processor
              Parallel::Status id_status (this->comm().probe (Parallel::any_source, id_tags[blk]));
              std::vector<dof_id_type> & ids (recv_ids[id_status.source()]);
              this->comm().receive (id_status.source(), ids, id_tags[blk]);
#else
              std::vector<dof_id_type> & ids (recv_ids[0]);
              ids = xfer_ids[blk];
#endif
 
              // note its possible we didn't receive values for objects in
              // this block if they have no components allocated.
              for (std::size_t idx=0, sz=ids.size(); idx<sz; idx+=2)
                {
                  const dof_id_type
                    local_idx          = ids[idx+0]-first_object,
                    n_vals_tot_allvecs = ids[idx+1];
 
                  libmesh_assert_less (local_idx, n_objects_blk);
                  libmesh_assert_less (local_idx, obj_val_offsets.size());
 
                  obj_val_offsets[local_idx] = n_vals_tot_allvecs;
                }
 
#ifdef LIBMESH_HAVE_MPI
              // blocking receive values for this block, imposing no particular order on processor
              Parallel::Status val_status  (this->comm().probe (Parallel::any_source, val_tags[blk]));
              std::vector<Number> & vals    (recv_vals[val_status.source()]);
              this->comm().receive (val_status.source(), vals, val_tags[blk]);
#else
              // straight copy without MPI
              std::vector<Number> & vals (recv_vals[0]);
              vals = send_vals[blk];
#endif
 
              n_val_recvd_blk += vals.size();
            }
 
          // We need the offsets into the output_vals vector for each object.
          // fortunately, this is simply the partial sum of the total number
          // of components for each object
          std::partial_sum(obj_val_offsets.begin(), obj_val_offsets.end(),
                           obj_val_offsets.begin());
 
          // wait on any previous asynchronous IO - this *must* complete before
          // we start messing with the output_vals buffer!
          if (async_io.get()) async_io->join();
 
          // this is the actual output buffer that will be written to disk.
          // at ths point we finally know wha size it will be.
          output_vals.resize(n_val_recvd_blk);
 
          // pack data from all processors into output values
          for (auto proc : make_range(this->n_processors()))
            {
              const std::vector<dof_id_type> & ids (recv_ids [proc]);
              const std::vector<Number>      & vals(recv_vals[proc]);
              std::vector<Number>::const_iterator proc_vals(vals.begin());
 
              for (std::size_t idx=0, sz=ids.size(); idx<sz; idx+=2)
                {
                  const dof_id_type
                    local_idx          = ids[idx+0]-first_object,
                    n_vals_tot_allvecs = ids[idx+1];
 
                  // put this object's data into the proper location
                  // in  the output buffer
                  std::vector<Number>::iterator out_vals(output_vals.begin());
                  if (local_idx != 0)
                    std::advance (out_vals, obj_val_offsets[local_idx-1]);
 
                  for (unsigned int val=0; val<n_vals_tot_allvecs; val++, ++out_vals, ++proc_vals)
                    {
                      libmesh_assert (out_vals  != output_vals.end());
                      libmesh_assert (proc_vals != vals.end());
                      *out_vals = *proc_vals;
                    }
                }
            }
 
          // output_vals buffer is now filled for this block.
          // write it to disk
          async_io = std::make_unique<Threads::Thread>(threaded_io);
          written_length += output_vals.size();
        }
 
      // wait on any previous asynchronous IO - this *must* complete before
      // our stuff goes out of scope
      async_io->join();
    }
 
  Parallel::wait(id_requests);
  Parallel::wait(val_requests);
 
  // we need some synchronization here.  Because this method
  // can be called for a range of nodes, then a range of elements,
  // we need some mechanism to prevent processors from racing past
  // to the next range and overtaking ongoing communication.  one
  // approach would be to figure out unique tags for each range,
  // but for now we just impose a barrier here.  And might as
  // well have it do some useful work.
  this->comm().broadcast(written_length);
 
  return written_length;
}

References TIMPI::any_source, libMesh::Parallel::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::Parallel::Communicator::get_unique_tag(), libMesh::invalid_uint, libMesh::libmesh_assert(), libMesh::make_range(), libMesh::ParallelObject::n_processors(), libMesh::System::n_vars(), libMesh::System::number(), libMesh::ParallelObject::processor_id(), libMesh::Parallel::Communicator::receive(), libMesh::Parallel::Communicator::send(), TIMPI::Status::source(), and TIMPI::wait().

Referenced by libMesh::System::write_serialized_vector(), and libMesh::System::write_serialized_vectors().

◆ 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 1518 of file system_io.C.

{
  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";
 
  // }
}

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::RBConstruction::write_riesz_representors_to_files(), and libMesh::TransientRBConstruction::write_riesz_representors_to_files().

◆ write_serialized_vector()

dof_id_type libMesh::System::write_serialized_vector	(	Xdr &	io,
		const NumericVector< Number > &	vec
	)		const

privateinherited

Writes a vector for this System.

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

Returns: The number of values written.

Definition at line 1968 of file system_io.C.

{
  parallel_object_only();
 
  libmesh_assert (io.writing());
 
  dof_id_type vec_length = vec.size();
  if (this->processor_id() == 0) io.data (vec_length, "# vector length");
 
  dof_id_type written_length = 0;
 
  //---------------------------------
  // Collect the values for all nodes
  written_length += cast_int<dof_id_type>
    (this->write_serialized_blocked_dof_objects (std::vector<const NumericVector<Number> *>(1,&vec),
                                                 this->get_mesh().n_nodes(),
                                                 this->get_mesh().local_nodes_begin(),
                                                 this->get_mesh().local_nodes_end(),
                                                 io));
 
  //------------------------------------
  // Collect the values for all elements
  written_length += cast_int<dof_id_type>
    (this->write_serialized_blocked_dof_objects (std::vector<const NumericVector<Number> *>(1,&vec),
                                                 this->get_mesh().n_elem(),
                                                 this->get_mesh().local_elements_begin(),
                                                 this->get_mesh().local_elements_end(),
                                                 io));
 
  //-------------------------------------------
  // Finally loop over all the SCALAR variables
  for (auto var : make_range(this->n_vars()))
    if (this->variable(var).type().family == SCALAR)
      {
        written_length +=
          this->write_SCALAR_dofs (vec, var, io);
      }
 
  if (this->processor_id() == 0)
    libmesh_assert_equal_to (written_length, vec_length);
 
  return written_length;
}

References libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), n_nodes, libMesh::System::n_vars(), libMesh::ParallelObject::processor_id(), libMesh::SCALAR, libMesh::NumericVector< T >::size(), libMesh::Variable::type(), libMesh::System::variable(), libMesh::System::write_SCALAR_dofs(), libMesh::System::write_serialized_blocked_dof_objects(), and libMesh::Xdr::writing().

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

◆ 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 2111 of file system_io.C.

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

References libMesh::Xdr::data(), libMesh::FEType::family, libMesh::System::get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshBase::n_elem(), libMesh::MeshBase::n_nodes(), n_nodes, libMesh::System::n_vars(), libMesh::ParallelObject::processor_id(), libMesh::SCALAR, libMesh::Variable::type(), 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().

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

{
  /* 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);
             }
         }
     });
}

References libMesh::System::get_mesh(), mesh, libMesh::System::n_vars(), libMesh::System::number(), libMesh::Threads::parallel_for(), and libMesh::NumericVector< T >::set().

Member Data Documentation

◆ _active

bool libMesh::System::_active

privateinherited

Flag stating if the system is active or not.

Definition at line 2252 of file system.h.

Referenced by libMesh::System::activate(), libMesh::System::active(), and libMesh::System::deactivate().

◆ _additional_data_written

unsigned int libMesh::System::_additional_data_written

privateinherited

This flag is used only when reading in a system from file.

Based on the system header, it keeps track of how many additional vectors were actually written for this file.

Definition at line 2313 of file system.h.

Referenced by libMesh::System::read_header(), libMesh::System::read_parallel_data(), and libMesh::System::read_serialized_data().

◆ _assemble_system_function

void(* libMesh::System::_assemble_system_function) (EquationSystems &es, const std::string &name)

privateinherited

Function that assembles the system.

Definition at line 2176 of file system.h.

◆ _assemble_system_object

Assembly* libMesh::System::_assemble_system_object

privateinherited

Object that assembles the system.

Definition at line 2182 of file system.h.

◆ _basic_system_only

bool libMesh::System::_basic_system_only

privateinherited

Holds true if the components of more advanced system types (e.g.

system matrices) should not be initialized.

Definition at line 2300 of file system.h.

Referenced by libMesh::System::init_data(), libMesh::System::reinit(), libMesh::System::reinit_mesh(), and libMesh::System::set_basic_system_only().

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

◆ _condensed_dofs_initialized

bool libMesh::CondensedEigenSystem::_condensed_dofs_initialized

privateinherited

A private flag to indicate whether the condensed dofs have been initialized.

Definition at line 202 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::have_condensed_dofs(), libMesh::CondensedEigenSystem::initialize_condensed_dofs(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), and libMesh::CondensedEigenSystem::reinit().

◆ _condensed_matrix_A

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

privateinherited

The (condensed) system matrix for standard eigenvalue problems.

Definition at line 217 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::add_matrices(), libMesh::CondensedEigenSystem::clear(), libMesh::CondensedEigenSystem::get_condensed_matrix_A(), libMesh::CondensedEigenSystem::has_condensed_matrix_A(), and libMesh::CondensedEigenSystem::solve().

◆ _condensed_matrix_B

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

privateinherited

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

Definition at line 222 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::add_matrices(), libMesh::CondensedEigenSystem::clear(), libMesh::CondensedEigenSystem::get_condensed_matrix_B(), libMesh::CondensedEigenSystem::has_condensed_matrix_B(), and libMesh::CondensedEigenSystem::solve().

◆ _condensed_precond_matrix

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

privateinherited

The condensed preconditioning matrix.

Definition at line 227 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::add_matrices(), libMesh::CondensedEigenSystem::clear(), libMesh::CondensedEigenSystem::get_condensed_precond_matrix(), libMesh::CondensedEigenSystem::has_condensed_precond_matrix(), and libMesh::CondensedEigenSystem::solve().

◆ _constrain_system_function

void(* libMesh::System::_constrain_system_function) (EquationSystems &es, const std::string &name)

privateinherited

Function to impose constraints.

Definition at line 2187 of file system.h.

◆ _constrain_system_object

Constraint* libMesh::System::_constrain_system_object

privateinherited

Object that constrains the system.

Definition at line 2193 of file system.h.

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

◆ _create_submatrices_in_solve

bool libMesh::CondensedEigenSystem::_create_submatrices_in_solve

privateinherited

Denotes whether to create the condensed submatrices from the global matrices in the solve.

Definition at line 212 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::dont_create_submatrices_in_solve(), and libMesh::CondensedEigenSystem::solve().

◆ _discrete_parameter_values

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

privateinherited

Map that defines the allowable values of any discrete parameters.

Definition at line 250 of file rb_parametrized.h.

Referenced by libMesh::RBParametrized::get_discrete_parameter_values(), libMesh::RBParametrized::initialize_parameters(), and libMesh::RBParametrized::is_discrete_parameter().

◆ _dof_map

std::unique_ptr<DofMap> libMesh::System::_dof_map

privateinherited

Data structure describing the relationship between nodes, variables, etc... and degrees of freedom.

Definition at line 2225 of file system.h.

Referenced by libMesh::System::add_vector(), libMesh::System::clear(), libMesh::System::current_solution(), libMesh::System::get_dof_map(), libMesh::System::get_dof_map(), libMesh::System::init_data(), libMesh::System::n_constrained_dofs(), libMesh::System::n_dofs(), libMesh::System::n_local_constrained_dofs(), libMesh::System::n_local_dofs(), libMesh::System::restrict_vectors(), and libMesh::System::update().

◆ _eigen_problem_type

EigenProblemType libMesh::EigenSystem::_eigen_problem_type

privateinherited

The type of the eigenvalue problem.

Definition at line 409 of file eigen_system.h.

Referenced by libMesh::EigenSystem::generalized(), libMesh::EigenSystem::get_eigenproblem_type(), and libMesh::EigenSystem::set_eigenproblem_type().

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

◆ _equation_systems

EquationSystems& libMesh::System::_equation_systems

privateinherited

Constant reference to the EquationSystems object used for the simulation.

Definition at line 2231 of file system.h.

Referenced by libMesh::System::get_equation_systems(), and libMesh::System::get_equation_systems().

◆ _first_local_index

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::_first_local_index

privateinherited

The first sample-vector index from the global vector which is stored in the _training_parameters on this processor.

_n_local_training_samples is equivalent to the .size() of any vector in _training_parameters.

Definition at line 313 of file rb_construction_base.h.

◆ _have_condensed_dofs

bool libMesh::CondensedEigenSystem::_have_condensed_dofs

privateinherited

Whether there are any condensed degrees of freedom.

Definition at line 207 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::get_eigenpair(), libMesh::CondensedEigenSystem::have_condensed_dofs(), libMesh::CondensedEigenSystem::initialize_condensed_dofs(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::CondensedEigenSystem::n_global_non_condensed_dofs(), and libMesh::CondensedEigenSystem::solve().

◆ _hide_output

bool libMesh::System::_hide_output

privateinherited

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

Definition at line 2338 of file system.h.

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

◆ _init_system_function

void(* libMesh::System::_init_system_function) (EquationSystems &es, const std::string &name)

privateinherited

Function that initializes the system.

Definition at line 2165 of file system.h.

◆ _init_system_object

Initialization* libMesh::System::_init_system_object

privateinherited

Object that initializes the system.

Definition at line 2171 of file system.h.

◆ _is_initialized

bool libMesh::System::_is_initialized

privateinherited

true when additional vectors and variables do not require immediate initialization, false otherwise.

Definition at line 2306 of file system.h.

Referenced by libMesh::System::add_vector(), libMesh::System::clear(), libMesh::System::compare(), libMesh::System::init_data(), and libMesh::System::is_initialized().

◆ _matrices

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

privateinherited

◆ _matrices_initialized

bool libMesh::System::_matrices_initialized

privateinherited

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

Definition at line 2287 of file system.h.

Referenced by libMesh::System::can_add_matrices(), libMesh::System::clear(), libMesh::System::init_matrices(), libMesh::System::late_matrix_init(), and libMesh::System::prefer_hash_table_matrix_assembly().

◆ _matrix_types

std::map<std::string, ParallelType, std::less<> > libMesh::System::_matrix_types

privateinherited

Holds the types of the matrices.

Definition at line 2282 of file system.h.

Referenced by libMesh::System::add_matrix(), libMesh::System::add_matrix(), libMesh::System::add_matrix(), and libMesh::System::init_matrices().

◆ _mesh

MeshBase& libMesh::System::_mesh

privateinherited

Constant reference to the mesh data structure used for the simulation.

Definition at line 2237 of file system.h.

Referenced by libMesh::System::get_mesh(), libMesh::System::get_mesh(), and libMesh::System::reinit_constraints().

◆ _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_converged_eigenpairs

unsigned int libMesh::EigenSystem::_n_converged_eigenpairs

privateinherited

The number of converged eigenpairs.

Definition at line 399 of file eigen_system.h.

Referenced by libMesh::EigenSystem::get_n_converged(), libMesh::EigenSystem::set_n_converged(), and libMesh::EigenSystem::solve_helper().

◆ _n_global_training_samples

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::_n_global_training_samples

privateinherited

Definition at line 315 of file rb_construction_base.h.

◆ _n_iterations

unsigned int libMesh::EigenSystem::_n_iterations

privateinherited

The number of iterations of the eigen solver algorithm.

Definition at line 404 of file eigen_system.h.

Referenced by libMesh::EigenSystem::get_n_iterations(), libMesh::EigenSystem::set_n_iterations(), and libMesh::EigenSystem::solve_helper().

◆ _n_local_training_samples

numeric_index_type libMesh::RBConstructionBase< CondensedEigenSystem >::_n_local_training_samples

privateinherited

Definition at line 314 of file rb_construction_base.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(), libMesh::ReferenceCounter::ReferenceCounter(), 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(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _normalize_solution_snapshots

bool libMesh::RBConstructionBase< CondensedEigenSystem >::_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.

◆ _prefer_hash_table_matrix_assembly

bool libMesh::System::_prefer_hash_table_matrix_assembly

privateinherited

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

Definition at line 2348 of file system.h.

Referenced by libMesh::System::init_matrices(), and libMesh::System::prefer_hash_table_matrix_assembly().

◆ _prefix_with_name

bool libMesh::System::_prefix_with_name

privateinherited

Whether we are name prefixing solver options.

Definition at line 2358 of file system.h.

Referenced by libMesh::System::prefix_with_name(), and libMesh::System::prefix_with_name().

◆ _qoi

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

privateinherited

Values of the quantities of interest.

This vector needs to be both resized and filled by the user before any quantity of interest assembly is done and before any sensitivities are calculated. Use the get_qoi_values() accessor to get these values.

Definition at line 2367 of file system.h.

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

◆ _qoi_error_estimates

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

privateinherited

Vector to hold error estimates for qois, either from a steady state calculation, or from a single unsteady solver timestep.

Used by the library after resizing to match the size of the qoi vector. User code can use this for accumulating error estimates for example. Use the set_qoi_error_estimate()/get_qoi_error_estimate_value() accessors to set/get these values.

Definition at line 2377 of file system.h.

◆ _qoi_evaluate_derivative_function

void(* libMesh::System::_qoi_evaluate_derivative_function) (EquationSystems &es, const std::string &name, const QoISet &qoi_indices, bool include_liftfunc, bool apply_constraints)

privateinherited

Function to evaluate quantity of interest derivative.

Definition at line 2210 of file system.h.

◆ _qoi_evaluate_derivative_object

QOIDerivative* libMesh::System::_qoi_evaluate_derivative_object

privateinherited

Object to compute derivatives of quantities of interest.

Definition at line 2219 of file system.h.

◆ _qoi_evaluate_function

void(* libMesh::System::_qoi_evaluate_function) (EquationSystems &es, const std::string &name, const QoISet &qoi_indices)

privateinherited

Function to evaluate quantity of interest.

Definition at line 2198 of file system.h.

◆ _qoi_evaluate_object

QOI* libMesh::System::_qoi_evaluate_object

privateinherited

Object to compute quantities of interest.

Definition at line 2205 of file system.h.

◆ _require_sparsity_pattern

bool libMesh::System::_require_sparsity_pattern

privateinherited

Whether any of our matrices require an initial sparsity pattern computation in order to determine preallocation.

Definition at line 2353 of file system.h.

Referenced by libMesh::System::init_matrices(), and libMesh::System::reinit().

◆ _solution_projection

bool libMesh::System::_solution_projection

privateinherited

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

This is true by default.

Definition at line 2294 of file system.h.

Referenced by libMesh::System::project_solution_on_reinit(), and libMesh::System::restrict_vectors().

◆ _sys_name

const std::string libMesh::System::_sys_name

privateinherited

A name associated with this system.

Definition at line 2242 of file system.h.

Referenced by libMesh::System::clear(), libMesh::System::compare(), and libMesh::System::name().

◆ _sys_number

const unsigned int libMesh::System::_sys_number

privateinherited

The number associated with this system.

Definition at line 2247 of file system.h.

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

◆ _training_parameters

std::map<std::string, std::vector<RBParameter> > libMesh::RBConstructionBase< CondensedEigenSystem >::_training_parameters

privateinherited

The training samples for each parameter.

When serial_training_set is true, the map contains all samples of all parameters. Otherwise, the sample vectors will only contain the values for the local samples as defined by _first_local_index and _n_local_training_samples. Mapped from parameter_name -> sample_vector -> value_vector.

Definition at line 306 of file rb_construction_base.h.

◆ _training_parameters_initialized

bool libMesh::RBConstructionBase< CondensedEigenSystem >::_training_parameters_initialized

privateinherited

Boolean flag to indicate whether or not the parameter ranges have been initialized.

Definition at line 297 of file rb_construction_base.h.

◆ _training_parameters_random_seed

int libMesh::RBConstructionBase< CondensedEigenSystem >::_training_parameters_random_seed

privateinherited

If < 0, use std::time() * processor_id() to seed the random number generator for the training parameters (default).

If >= 0, use the provided value * processor_id() as the random number generator seed.

Definition at line 323 of file rb_construction_base.h.

◆ _use_shell_matrices

bool libMesh::EigenSystem::_use_shell_matrices

privateinherited

A boolean flag to indicate whether or not to use shell matrices.

Definition at line 414 of file eigen_system.h.

◆ _use_shell_precond_matrix

bool libMesh::EigenSystem::_use_shell_precond_matrix

privateinherited

A boolean flag to indicate whether or not to use a shell preconditioning matrix.

Definition at line 419 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::EigenSystem::get_precond_matrix(), libMesh::EigenSystem::get_precond_matrix(), libMesh::EigenSystem::get_shell_precond_matrix(), libMesh::EigenSystem::get_shell_precond_matrix(), libMesh::EigenSystem::solve_helper(), libMesh::EigenSystem::use_shell_precond_matrix(), and libMesh::EigenSystem::use_shell_precond_matrix().

◆ _vector_is_adjoint

std::map<std::string, int, std::less<> > libMesh::System::_vector_is_adjoint

privateinherited

Holds non-negative if a vector by that name should be projected using adjoint constraints/BCs, -1 if primal.

Definition at line 2272 of file system.h.

Referenced by libMesh::System::add_vector(), libMesh::System::clear(), libMesh::System::remove_vector(), libMesh::System::set_vector_as_adjoint(), and libMesh::System::vector_is_adjoint().

◆ _vector_projections

std::map<std::string, bool, std::less<> > libMesh::System::_vector_projections

privateinherited

Holds true if a vector by that name should be projected onto a changed grid, false if it should be zeroed.

Definition at line 2266 of file system.h.

Referenced by libMesh::System::add_vector(), libMesh::System::clear(), libMesh::System::remove_vector(), libMesh::System::restrict_vectors(), libMesh::System::set_vector_preservation(), libMesh::System::vector_preservation(), and libMesh::System::write_header().

◆ _vectors

std::map<std::string, std::unique_ptr<NumericVector<Number> >, std::less<> > libMesh::System::_vectors

privateinherited

Some systems need an arbitrary number of vectors.

This map allows names to be associated with arbitrary vectors. All the vectors in this map will be distributed in the same way as the solution vector.

Definition at line 2260 of file system.h.

◆ _written_var_indices

std::vector<unsigned int> libMesh::System::_written_var_indices

privateinherited

This vector is used only when reading in a system from file.

Based on the system header, it keeps track of any index remapping between variable names in the data file and variable names in the already-constructed system. I.e. if we have a system with variables "A1", "A2", "B1", and "B2", but we read in a data file with only "A1" and "B1" defined, then we don't want to try and read in A2 or B2, and we don't want to assign A1 and B1 values to different dof indices.

Definition at line 2325 of file system.h.

Referenced by libMesh::System::read_header(), libMesh::System::read_parallel_data(), libMesh::System::read_serialized_blocked_dof_objects(), and libMesh::System::read_serialized_vector().

◆ adjoint_already_solved

bool libMesh::System::adjoint_already_solved

privateinherited

Has the adjoint problem already been solved? If the user sets adjoint_already_solved to true, we won't waste time solving it again.

Definition at line 2332 of file system.h.

Referenced by libMesh::System::is_adjoint_already_solved(), and libMesh::System::set_adjoint_already_solved().

◆ 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::System::disable_cache(), libMesh::ImplicitSystem::disable_cache(), main(), libMesh::RBConstruction::RBConstruction(), RBSCMConstruction(), libMesh::ImplicitSystem::sensitivity_solve(), libMesh::CondensedEigenSystem::solve(), libMesh::EigenSystem::solve(), and libMesh::LinearImplicitSystem::solve().

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

Referenced by libMesh::__libmesh_petsc_diff_solver_jacobian(), libMesh::__libmesh_petsc_diff_solver_residual(), libMesh::UniformRefinementEstimator::_estimate_error(), alternative_fe_assembly(), libMesh::NonlinearImplicitSystem::assembly(), libMesh::VariationalSmootherSystem::assembly(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::System::clear(), libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), libMesh::System::current_solution(), DMlibMeshFunction(), DMlibMeshJacobian(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), fe_assembly(), libMesh::PetscNonlinearSolver< Number >::force_new_preconditioner(), libMesh::StaticCondensation::init(), libMesh::System::init_data(), libMesh::FEMContext::pre_fe_reinit(), libMesh::System::re_update(), libMesh::System::reinit(), libMesh::System::restrict_vectors(), OverlappingAlgebraicGhostingTest::run_ghosting_test(), OverlappingCouplingGhostingTest::run_sparsity_pattern_test(), SolidSystem::save_initial_mesh(), libMesh::RBConstruction::set_context_solution_vec(), setup(), MeshFunctionTest::test_bad_gradient_var_with_out_of_mesh_value(), MeshFunctionTest::test_bad_hessian_var_with_out_of_mesh_value(), MeshFunctionTest::test_subdomain_id_sets(), MeshInputTest::testCopyElementVectorImpl(), FETest< order, family, elem_type, CaseName >::testGradU(), FETest< order, family, elem_type, CaseName >::testGradUComp(), FETest< order, family, elem_type, CaseName >::testHessU(), FETest< order, family, elem_type, CaseName >::testHessUComp(), FETest< order, family, elem_type, CaseName >::testU(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::TransientRBConstruction::truth_solve(), libMesh::System::update(), libMesh::Nemesis_IO_Helper::write_element_values(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

◆ eigen_solver

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

inherited

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

Public access to this member variable will be deprecated in the future! Use get_eigen_solver instead.

Definition at line 362 of file eigen_system.h.

Referenced by libMesh::EigenSystem::clear(), compute_SCM_bounding_box(), evaluate_stability_constant(), libMesh::EigenSystem::get_eigen_solver(), libMesh::EigenSystem::get_eigen_solver(), libMesh::EigenSystem::get_eigenpair(), libMesh::CondensedEigenSystem::get_eigenpair(), libMesh::EigenSystem::get_eigenvalue(), libMesh::EigenSystem::set_eigenproblem_type(), libMesh::EigenSystem::set_initial_space(), and libMesh::EigenSystem::solve_helper().

◆ 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 libMesh::JumpErrorEstimator::estimate_error(), CurlCurlSystem::init_data(), and set_system_parameters().

◆ inner_product_storage_vector

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

protectedinherited

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

Definition at line 288 of file rb_construction_base.h.

◆ local_non_condensed_dofs_vector

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

inherited

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

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

Definition at line 176 of file condensed_eigen_system.h.

Referenced by libMesh::CondensedEigenSystem::copy_sub_to_super(), libMesh::CondensedEigenSystem::copy_super_to_sub(), libMesh::CondensedEigenSystem::copy_super_to_sub(), libMesh::CondensedEigenSystem::get_eigenpair(), libMesh::CondensedEigenSystem::initialize_condensed_dofs(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::CondensedEigenSystem::n_global_non_condensed_dofs(), and libMesh::CondensedEigenSystem::solve().

◆ matrix_A

SparseMatrix<Number>* libMesh::EigenSystem::matrix_A

inherited

The system matrix for standard eigenvalue problems.

Public access to this member variable will be deprecated in the future! Use get_matrix_A() instead.

Definition at line 313 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), Aq_inner_product(), libMesh::EigenSystem::clear(), compute_SCM_bounding_box(), evaluate_stability_constant(), libMesh::EigenSystem::get_matrix_A(), libMesh::EigenSystem::get_matrix_A(), libMesh::EigenSystem::has_matrix_A(), libMesh::CondensedEigenSystem::solve(), and libMesh::EigenSystem::solve().

◆ matrix_B

SparseMatrix<Number>* libMesh::EigenSystem::matrix_B

inherited

A second system matrix for generalized eigenvalue problems.

Public access to this member variable will be deprecated in the future! Use get_matrix_B() instead.

Definition at line 321 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), B_inner_product(), libMesh::EigenSystem::clear(), libMesh::EigenSystem::get_matrix_B(), libMesh::EigenSystem::get_matrix_B(), libMesh::EigenSystem::has_matrix_B(), load_matrix_B(), libMesh::CondensedEigenSystem::solve(), libMesh::EigenSystem::solve(), and libMesh::EigenSystem::solve_helper().

◆ 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::CondensedEigenSystem::solve(), libMesh::EigenSystem::solve(), and libMesh::EigenSystem::solve_helper().

◆ parameters_initialized

bool libMesh::RBParametrized::parameters_initialized

privateinherited

Flag indicating whether the parameters have been initialized.

Definition at line 234 of file rb_parametrized.h.

◆ parameters_max

RBParameters libMesh::RBParametrized::parameters_max

privateinherited

Definition at line 245 of file rb_parametrized.h.

Referenced by libMesh::RBParametrized::clear(), libMesh::RBParametrized::get_n_params(), libMesh::RBParametrized::get_parameter_max(), libMesh::RBParametrized::get_parameters_max(), and libMesh::RBParametrized::initialize_parameters().

◆ parameters_min

RBParameters libMesh::RBParametrized::parameters_min

privateinherited

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

Definition at line 244 of file rb_parametrized.h.

Referenced by libMesh::RBParametrized::clear(), libMesh::RBParametrized::get_n_params(), libMesh::RBParametrized::get_parameter_min(), libMesh::RBParametrized::get_parameters_min(), and libMesh::RBParametrized::initialize_parameters().

◆ precond_matrix

SparseMatrix<Number>* libMesh::EigenSystem::precond_matrix

inherited

A preconditioning matrix.

Public access to this member variable will be deprecated in the future! Use get_precond_matrix() instead.

Definition at line 345 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::EigenSystem::clear(), libMesh::EigenSystem::get_precond_matrix(), libMesh::EigenSystem::get_precond_matrix(), libMesh::EigenSystem::has_precond_matrix(), libMesh::CondensedEigenSystem::solve(), and libMesh::EigenSystem::solve().

◆ project_with_constraints

bool libMesh::System::project_with_constraints

privateinherited

Do we want to apply constraints while projecting vectors ?

Definition at line 2343 of file system.h.

Referenced by libMesh::System::get_project_with_constraints(), and libMesh::System::set_project_with_constraints().

◆ quiet_mode

bool libMesh::RBConstructionBase< CondensedEigenSystem >::quiet_mode

protectedinherited

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

Definition at line 265 of file rb_construction_base.h.

◆ rb_scm_eval

RBSCMEvaluation* libMesh::RBSCMConstruction::rb_scm_eval

private

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

Definition at line 244 of file rb_scm_construction.h.

Referenced by compute_SCM_bounding_box(), compute_SCM_bounds_on_training_set(), enrich_C_J(), evaluate_stability_constant(), get_rb_scm_evaluation(), perform_SCM_greedy(), print_info(), resize_SCM_vectors(), and set_rb_scm_evaluation().

◆ RB_system_name

std::string libMesh::RBSCMConstruction::RB_system_name

protected

The name of the associated RB system.

Definition at line 236 of file rb_scm_construction.h.

Referenced by add_scaled_symm_Aq(), load_matrix_B(), perform_SCM_greedy(), and set_RB_system_name().

◆ SCM_training_tolerance

Real libMesh::RBSCMConstruction::SCM_training_tolerance

protected

Tolerance which controls when to terminate the SCM Greedy.

Definition at line 231 of file rb_scm_construction.h.

Referenced by get_SCM_training_tolerance(), perform_SCM_greedy(), process_parameters_file(), and set_SCM_training_tolerance().

◆ serial_training_set

bool libMesh::RBConstructionBase< CondensedEigenSystem >::serial_training_set

protectedinherited

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

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

Definition at line 273 of file rb_construction_base.h.

◆ shell_matrix_A

std::unique_ptr<ShellMatrix<Number> > libMesh::EigenSystem::shell_matrix_A

inherited

The system shell matrix for standard eigenvalue problems.

Public access to this member variable will be deprecated in the future! Use get_shell_matrix_A() instead.

Definition at line 329 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::EigenSystem::clear(), libMesh::EigenSystem::get_shell_matrix_A(), libMesh::EigenSystem::get_shell_matrix_A(), libMesh::EigenSystem::has_shell_matrix_A(), libMesh::EigenSystem::init_matrices(), libMesh::EigenSystem::reinit(), and libMesh::EigenSystem::solve_helper().

◆ shell_matrix_B

std::unique_ptr<ShellMatrix<Number> > libMesh::EigenSystem::shell_matrix_B

inherited

A second system shell matrix for generalized eigenvalue problems.

Public access to this member variable will be deprecated in the future! Use get_shell_matrix_B() instead.

Definition at line 337 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::EigenSystem::clear(), libMesh::EigenSystem::get_shell_matrix_B(), libMesh::EigenSystem::get_shell_matrix_B(), libMesh::EigenSystem::has_shell_matrix_B(), libMesh::EigenSystem::init_matrices(), libMesh::EigenSystem::reinit(), and libMesh::EigenSystem::solve_helper().

◆ shell_precond_matrix

std::unique_ptr<ShellMatrix<Number> > libMesh::EigenSystem::shell_precond_matrix

inherited

A preconditioning shell matrix.

Public access to this member variable will be deprecated in the future! Use get_shell_precond_matrix() instead.

Definition at line 353 of file eigen_system.h.

Referenced by libMesh::EigenSystem::add_matrices(), libMesh::EigenSystem::clear(), libMesh::EigenSystem::get_shell_precond_matrix(), libMesh::EigenSystem::get_shell_precond_matrix(), libMesh::EigenSystem::has_shell_precond_matrix(), libMesh::EigenSystem::init_matrices(), libMesh::EigenSystem::reinit(), and libMesh::EigenSystem::solve_helper().

◆ 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 >::ProjectInteriors::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::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::NewmarkSolver::_general_residual(), libMesh::Euler2Solver::_general_residual(), libMesh::EulerSolver::_general_residual(), libMesh::SteadySolver::_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 files:

include/reduced_basis/rb_scm_construction.h
src/reduced_basis/rb_scm_construction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_matrices_iterator

◆ const_vectors_iterator

◆ Counts [1/2]

◆ Counts [2/2]

◆ GradientFunctionPointer

◆ matrices_iterator

◆ Parent

◆ sys_type

◆ ValueFunctionPointer

◆ vectors_iterator

Constructor & Destructor Documentation

◆ RBSCMConstruction() [1/3]

◆ RBSCMConstruction() [2/3]

◆ RBSCMConstruction() [3/3]

◆ ~RBSCMConstruction()

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

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

◆ Aq_inner_product()

◆ assemble()

◆ assemble_qoi()

◆ assemble_qoi_derivative()

◆ assemble_residual_derivatives()

◆ attach_assemble_function()

◆ attach_assemble_object()

◆ attach_constraint_function()

◆ attach_constraint_object()

◆ attach_deflation_space()

◆ attach_init_function()

◆ attach_init_object()

◆ attach_QOI_derivative()

◆ attach_QOI_derivative_object()

◆ attach_QOI_function()

◆ attach_QOI_object()

◆ B_inner_product()

◆ boundary_project_solution() [1/2]

◆ boundary_project_solution() [2/2]

◆ boundary_project_vector() [1/2]

◆ boundary_project_vector() [2/2]

◆ broadcast_parameters()

◆ calculate_norm() [1/2]

◆ calculate_norm() [2/2]

◆ can_add_matrices()

◆ check_if_valid_params()

◆ clear()

◆ comm()

◆ compare()