Manages consistently variables, degrees of freedom, and coefficient vectors. More...

#include <system.h>

Inheritance diagram for libMesh::System:

Classes
class	Assembly
	Abstract base class to be used for system assembly. More...

class	Constraint
	Abstract base class to be used for system constraints. More...

class	Initialization
	Abstract base class to be used for system initialization. More...

class	QOI
	Abstract base class to be used for quantities of interest. More...

class	QOIDerivative
	Abstract base class to be used for derivatives of quantities of interest. More...

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

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

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

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

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

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

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

Public Member Functions
	System (EquationSystems &es, const std::string &name, const unsigned int number)
	Constructor. More...

	System (const System &)=delete
	Special functions. More...

System &	operator= (const System &)=delete

	System (System &&)=default

System &	operator= (System &&)=delete

virtual	~System ()

sys_type &	system ()

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

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

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

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

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

bool	is_initialized ()

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

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

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

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

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

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

virtual void	solve ()
	Solves the system. More...

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

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

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

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

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

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

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

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

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

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

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

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

const std::string &	name () const

virtual std::string	system_type () const

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

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

void	project_solution (ValueFunctionPointer fptr, GradientFunctionPointer gptr, const Parameters &parameters) const
	This method projects an arbitrary function onto the solution via L2 projections and nodal interpolations on each element. More...

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

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

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

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

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

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

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

unsigned int	number () const

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

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

const MeshBase &	get_mesh () const

MeshBase &	get_mesh ()

const DofMap &	get_dof_map () const

DofMap &	get_dof_map ()

const EquationSystems &	get_equation_systems () const

EquationSystems &	get_equation_systems ()

bool	active () const

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

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

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

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

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

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

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

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

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

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

bool	have_vector (std::string_view vec_name) const

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

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

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

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

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

NumericVector< Number > &	get_vector (std::string_view vec_name)

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

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

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

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

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

int	vector_is_adjoint (std::string_view vec_name) const

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

bool	vector_preservation (std::string_view vec_name) const

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

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

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

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

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

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

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

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

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

NumericVector< Number > &	add_weighted_sensitivity_solution ()

NumericVector< Number > &	get_weighted_sensitivity_solution ()

const NumericVector< Number > &	get_weighted_sensitivity_solution () const

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

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

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

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

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

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

unsigned int	n_vectors () const

unsigned int	n_matrices () const

unsigned int	n_vars () const

unsigned int	n_variable_groups () const

unsigned int	n_components () const

dof_id_type	n_dofs () const

dof_id_type	n_active_dofs () const

dof_id_type	n_constrained_dofs () const

dof_id_type	n_local_constrained_dofs () const

dof_id_type	n_local_dofs () const

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

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

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

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

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

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

bool	has_variable (std::string_view var) const

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

unsigned int	variable_number (std::string_view var) const

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

unsigned int	variable_scalar_number (std::string_view var, unsigned int component) const

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

const FEType &	variable_type (const unsigned int i) const

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

bool	identify_variable_groups () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

std::string	get_info () const

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

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

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

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

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

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

bool	has_constraint_object () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Number	current_solution (const dof_id_type global_dof_number) const

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

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

void	set_qoi (unsigned int qoi_index, Number qoi_value)

Number	get_qoi_value (unsigned int qoi_index) const

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

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

void	set_qoi_error_estimate (unsigned int qoi_index, Number qoi_error_estimate)

Number	get_qoi_error_estimate_value (unsigned int qoi_index) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	set_project_with_constraints (bool _project_with_constraints)

bool &	hide_output ()

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

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

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

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

bool	have_matrix (std::string_view mat_name) const

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

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

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

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

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

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

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

static void	disable_print_counter_info ()

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

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

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

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

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

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

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

Protected Member Functions
virtual void	init_data ()
	Initializes the data for the system. More...

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

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

bool	can_add_matrices () const

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

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

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

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

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

Protected Attributes
const Parallel::Communicator &	_communicator

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
std::vector< Number >	qoi
	Values of the quantities of interest. More...

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

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

Initialization *	_init_system_object
	Object that initializes the system. More...

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

Assembly *	_assemble_system_object
	Object that assembles the system. More...

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

Constraint *	_constrain_system_object
	Object that constrains the system. More...

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

QOI *	_qoi_evaluate_object
	Object to compute quantities of interest. More...

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

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

std::unique_ptr< DofMap >	_dof_map
	Data structure describing the relationship between nodes, variables, etc... More...

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

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

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

const unsigned int	_sys_number
	The number associated with this system. More...

std::vector< Variable >	_variables
	The `Variable` in this `System`. More...

std::vector< VariableGroup >	_variable_groups
	The `VariableGroup` in this `System`. More...

std::map< std::string, unsigned int, std::less<> >	_variable_numbers
	The variable numbers corresponding to user-specified names, useful for name-based lookups. More...

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

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

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

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

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

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

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

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

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

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

bool	_identify_variable_groups
	`true` when `VariableGroup` structures should be automatically identified, `false` otherwise. More...

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

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

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

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

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

Detailed Description

Manages consistently variables, degrees of freedom, and coefficient vectors.

This is the base class for classes which contain information related to any physical process that might be simulated. Such information may range from the actual solution values to algorithmic flags that may be used to control the numerical methods employed. In general, use an EquationSystems object to handle one or more of the children of this class.

Especially, this class manages the variables of the differential equation, the coefficient vectors and the DofMap, and ensures that these are consistent. It provides storage for the solution. Furthermore, (de-) serialization functionality is provided.

Author: Benjamin S. Kirk

Date: 2003-2004

Definition at line 96 of file system.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

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

Definition at line 767 of file system.h.

◆ Counts

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

protectedinherited

Data structure to log the information.

The log is identified by the class name.

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

Definition at line 542 of file system.h.

◆ matrices_iterator

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

Matrix iterator typedefs.

Definition at line 1809 of file system.h.

◆ sys_type

typedef System libMesh::System::sys_type

The type of system.

Definition at line 248 of file system.h.

◆ ValueFunctionPointer

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

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

◆ vectors_iterator

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

Vector iterator typedefs.

Definition at line 766 of file system.h.

Constructor & Destructor Documentation

◆ System() [1/3]

libMesh::System::System	(	EquationSystems &	es,
		const std::string &	name,
		const unsigned int	number
	)

Constructor.

Optionally initializes required data structures.

Definition at line 63 of file system.C.

Referenced by HeatSystem::init_context().

                                               :
 
   ParallelObject                    (es),
   assemble_before_solve             (true),
   use_fixed_solution                (false),
   extra_quadrature_order            (0),
   solution                          (NumericVector<Number>::build(this->comm())),
   current_local_solution            (NumericVector<Number>::build(this->comm())),
   time                              (0.),
   qoi                               (0),
   qoi_error_estimates               (0),
   _init_system_function             (nullptr),
   _init_system_object               (nullptr),
   _assemble_system_function         (nullptr),
   _assemble_system_object           (nullptr),
   _constrain_system_function        (nullptr),
   _constrain_system_object          (nullptr),
   _qoi_evaluate_function            (nullptr),
   _qoi_evaluate_object              (nullptr),
   _qoi_evaluate_derivative_function (nullptr),
   _qoi_evaluate_derivative_object   (nullptr),
   _dof_map                          (std::make_unique<DofMap>(number_in, es.get_mesh())),
   _equation_systems                 (es),
   _mesh                             (es.get_mesh()),
   _sys_name                         (name_in),
   _sys_number                       (number_in),
   _active                           (true),
   _matrices_initialized             (false),
   _solution_projection              (true),
   _basic_system_only                (false),
   _is_initialized                   (false),
   _identify_variable_groups         (true),
   _additional_data_written          (false),
   adjoint_already_solved            (false),
   _hide_output                      (false),
   project_with_constraints          (true)
 {
 }

◆ System() [2/3]

libMesh::System::System ( const System & )

delete

Special functions.

The copy constructor and assignment operator were previously declared as private libmesh_not_implemented() functions, this is the C++11 way of achieving the same effect.
The System holds references to Mesh and EquationSystems objects, therefore it can't be default move-assigned.
This class can be default move constructed.
The destructor dies with an error in dbg/devel modes if libMesh::closed()

◆ System() [3/3]

libMesh::System::System ( System && )

default

◆ ~System()

libMesh::System::~System ( )

virtual

Definition at line 106 of file system.C.

References libMesh::closed().

 {
   libmesh_exceptionless_assert (!libMesh::closed());
 }

Member Function Documentation

◆ activate()

void libMesh::System::activate ( )

inline

Activates the system.

Only active systems are solved.

Definition at line 2317 of file system.h.

References _active.

 {
   _active = true;
 }

◆ active()

bool libMesh::System::active ( ) const

inline

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

Definition at line 2309 of file system.h.

References _active.

 {
   return _active;
 }

◆ add_adjoint_rhs()

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

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

References add_vector().

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

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

◆ add_adjoint_solution()

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

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

References add_vector(), and set_vector_as_adjoint().

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

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

◆ add_matrices()

virtual void libMesh::System::add_matrices ( )

inlineprotectedvirtual

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

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

Definition at line 1903 of file system.h.

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

1903 {}

◆ add_matrix() [1/2]

SparseMatrix< Number > & libMesh::System::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.

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 mayor 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 985 of file system.C.

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

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

 {
   parallel_object_only();
 
   libmesh_assert(this->comm().verify(std::string(mat_name)));
   libmesh_assert(this->comm().verify(int(type)));
   libmesh_assert(this->comm().verify(int(mat_build_type)));
 
   // Return the matrix if it is already there.
   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,
      SparseMatrix<Number>::build(this->comm(),
                                  libMesh::default_solver_package(),
                                  mat_build_type));
 
   _matrix_types.emplace(mat_name, type);
 
   SparseMatrix<Number> & mat = *(pr.first->second);
 
   // Initialize it first if we've already initialized the others.
   this->late_matrix_init(mat, type);
 
   return mat;
 }

◆ add_matrix() [2/2]

template<template< typename > class MatrixType>

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

inline

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

References _matrices, _matrix_types, and late_matrix_init().

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

◆ add_sensitivity_rhs()

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

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

References add_vector().

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

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

◆ add_sensitivity_solution()

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

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

References add_vector().

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

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

◆ add_variable() [1/2]

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

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

References _variable_groups, _variable_numbers, _variables, libMesh::Variable::active_subdomains(), add_variables(), libMesh::ParallelObject::comm(), identify_variable_groups(), libMesh::Variable::implicitly_active(), is_initialized(), libMesh::libmesh_assert(), libMesh::make_range(), n_variable_groups(), n_vars(), variable(), variable_name(), and variable_type().

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), add_variable(), assemble_and_solve(), OverlappingTestBase::init(), SolidSystem::init_data(), CurlCurlSystem::init_data(), SimpleEIMConstruction::init_data(), HeatSystem::init_data(), SimpleRBConstruction::init_data(), main(), libMesh::ErrorVector::plot_error(), read_header(), RationalMapTest< elem_type >::setUp(), SlitMeshRefinedSystemTest::setUp(), FETestBase< order, family, elem_type, 1 >::setUp(), WriteVecAndScalar::setupTests(), SystemsTest::simpleSetup(), MultiEvaluablePredTest::test(), ConstraintOperatorTest::test1DCoarseningNewNodes(), ConstraintOperatorTest::test1DCoarseningOperator(), MeshfunctionDFEM::test_mesh_function_dfem(), MeshfunctionDFEM::test_mesh_function_dfem_grad(), MeshFunctionTest::test_p_level(), MeshFunctionTest::test_subdomain_id_sets(), SystemsTest::testAssemblyWithDgFemContext(), DofMapTest::testBadElemFECombo(), EquationSystemsTest::testBadVarNames(), SystemsTest::testBlockRestrictedVarNDofs(), SystemsTest::testBoundaryProjectCube(), DofMapTest::testConstraintLoopDetection(), MeshInputTest::testCopyElementSolutionImpl(), MeshInputTest::testCopyElementVectorImpl(), MeshInputTest::testCopyNodalSolutionImpl(), ConstraintOperatorTest::testCoreform(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), SystemsTest::testDofCouplingWithVarGroups(), DofMapTest::testDofOwner(), MeshInputTest::testDynaReadPatch(), MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData(), MeshAssignTest::testMeshMoveAssign(), PeriodicBCTest::testPeriodicBC(), EquationSystemsTest::testPostInitAddElem(), EquationSystemsTest::testPostInitAddRealSystem(), SystemsTest::testProjectCubeWithMeshFunction(), MeshInputTest::testProjectionRegression(), SystemsTest::testProjectMatrix1D(), SystemsTest::testProjectMatrix2D(), SystemsTest::testProjectMatrix3D(), InfFERadialTest::testRefinement(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), EquationSystemsTest::testReinitWithNodeElem(), EquationSystemsTest::testRepartitionThenReinit(), EquationSystemsTest::testSelectivePRefine(), BoundaryInfoTest::testShellFaceConstraints(), MeshInputTest::testSingleElementImpl(), WriteVecAndScalar::testWriteExodus(), and WriteVecAndScalar::testWriteNemesis().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   libmesh_assert(this->comm().verify(std::string(var)));
   libmesh_assert(this->comm().verify(type));
   libmesh_assert(this->comm().verify((active_subdomains == nullptr)));
 
   if (active_subdomains)
     libmesh_assert(this->comm().verify(active_subdomains->size()));
 
   // Make sure the variable isn't there already
   // or if it is, that it's the type we want
   for (auto v : make_range(this->n_vars()))
     if (this->variable_name(v) == var)
       {
         if (this->variable_type(v) == type)
           {
             // Check whether the existing variable's active subdomains also matches
             // the incoming variable's active subdomains. If they don't match, then
             // either it is an error by the user or the user is trying to change the
             // subdomain restriction after the variable has already been added, which
             // is not supported.
             const Variable & existing_var = this->variable(v);
 
             // Check whether active_subdomains is not provided/empty and the existing_var is implicitly_active()
             bool check1 = (!active_subdomains || active_subdomains->empty()) && existing_var.implicitly_active();
 
             // Check if the provided active_subdomains is equal to the existing_var's active_subdomains
             bool check2 = (active_subdomains && (*active_subdomains == existing_var.active_subdomains()));
 
             // If either of these checks passed, then we already have this variable
             if (check1 || check2)
               return _variables[v].number();
           }
 
         libmesh_error_msg("ERROR: incompatible variable " << var << " has already been added for this system!");
       }
 
   libmesh_assert(!this->is_initialized());
 
   if (this->n_variable_groups())
     {
       // Optimize for VariableGroups here - if the user is adding multiple
       // variables of the same FEType and subdomain restriction, catch
       // that here and add them as members of the same VariableGroup.
       //
       // start by setting this flag to whatever the user has requested
       // and then consider the conditions which should negate it.
       bool should_be_in_vg = this->identify_variable_groups();
 
       VariableGroup & vg(_variable_groups.back());
 
       // get a pointer to their subdomain restriction, if any.
       const std::set<subdomain_id_type> * const
         their_active_subdomains (vg.implicitly_active() ?
                                  nullptr : &vg.active_subdomains());
 
       // Different types?
       if (vg.type() != type)
         should_be_in_vg = false;
 
       // they are restricted, we aren't?
       if (their_active_subdomains &&
           (!active_subdomains || (active_subdomains && active_subdomains->empty())))
         should_be_in_vg = false;
 
       // they aren't restricted, we are?
       if (!their_active_subdomains && (active_subdomains && !active_subdomains->empty()))
         should_be_in_vg = false;
 
       if (their_active_subdomains && active_subdomains)
         // restricted to different sets?
         if (*their_active_subdomains != *active_subdomains)
           should_be_in_vg = false;
 
       // OK, after all that, append the variable to the vg if none of the conditions
       // were violated
       if (should_be_in_vg)
         {
           const unsigned int curr_n_vars = this->n_vars();
 
           std::string varstr(var);
 
           _variable_numbers[varstr] = curr_n_vars;
           vg.append (std::move(varstr));
           _variables.push_back(vg(vg.n_variables()-1));
 
           return curr_n_vars;
         }
     }
 
   // otherwise, fall back to adding a single variable group
   return this->add_variables (std::vector<std::string>(1, std::string(var)),
                               type,
                               active_subdomains);
 }

◆ add_variable() [2/2]

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

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

Definition at line 1407 of file system.C.

References add_variable().

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

◆ add_variables() [1/2]

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

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

References _variable_groups, _variable_numbers, _variables, libMesh::ParallelObject::comm(), identify_variable_groups(), is_initialized(), libMesh::libmesh_assert(), libMesh::make_range(), n_components(), n_variable_groups(), n_vars(), variable_name(), and variable_type().

Referenced by add_variable(), add_variables(), and SystemsTest::test100KVariables().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   libmesh_assert(!this->is_initialized());
 
   libmesh_assert(this->comm().verify(vars.size()));
   libmesh_assert(this->comm().verify(type));
   libmesh_assert(this->comm().verify((active_subdomains == nullptr)));
 
   if (active_subdomains)
     libmesh_assert(this->comm().verify(active_subdomains->size()));
 
   // Make sure the variable isn't there already
   // or if it is, that it's the type we want
   for (auto ovar : vars)
     {
       libmesh_assert(this->comm().verify(ovar));
 
       for (auto v : make_range(this->n_vars()))
         if (this->variable_name(v) == ovar)
           {
             if (this->variable_type(v) == type)
               return _variables[v].number();
 
             libmesh_error_msg("ERROR: incompatible variable " << ovar << " has already been added for this system!");
           }
     }
 
   if (this->n_variable_groups())
     {
       // Optimize for VariableGroups here - if the user is adding multiple
       // variables of the same FEType and subdomain restriction, catch
       // that here and add them as members of the same VariableGroup.
       //
       // start by setting this flag to whatever the user has requested
       // and then consider the conditions which should negate it.
       bool should_be_in_vg = this->identify_variable_groups();
 
       VariableGroup & vg(_variable_groups.back());
 
       // get a pointer to their subdomain restriction, if any.
       const std::set<subdomain_id_type> * const
         their_active_subdomains (vg.implicitly_active() ?
                                  nullptr : &vg.active_subdomains());
 
       // Different types?
       if (vg.type() != type)
         should_be_in_vg = false;
 
       // they are restricted, we aren't?
       if (their_active_subdomains &&
           (!active_subdomains || (active_subdomains && active_subdomains->empty())))
         should_be_in_vg = false;
 
       // they aren't restricted, we are?
       if (!their_active_subdomains && (active_subdomains && !active_subdomains->empty()))
         should_be_in_vg = false;
 
       if (their_active_subdomains && active_subdomains)
         // restricted to different sets?
         if (*their_active_subdomains != *active_subdomains)
           should_be_in_vg = false;
 
       // If after all that none of the conditions were violated,
       // append the variables to the vg and we're done
       if (should_be_in_vg)
         {
           unsigned int curr_n_vars = this->n_vars();
 
           for (auto ovar : vars)
             {
               curr_n_vars = this->n_vars();
 
               vg.append (ovar);
 
               _variables.push_back(vg(vg.n_variables()-1));
               _variable_numbers[ovar] = curr_n_vars;
             }
           return curr_n_vars;
         }
     }
 
   const unsigned int curr_n_vars = this->n_vars();
 
   const unsigned int next_first_component = this->n_components();
 
   // We weren't able to add to an existing variable group, so
   // add a new variable group to the list
   _variable_groups.push_back((active_subdomains == nullptr) ?
                              VariableGroup(this, vars, curr_n_vars,
                                            next_first_component, type) :
                              VariableGroup(this, vars, curr_n_vars,
                                            next_first_component, type, *active_subdomains));
 
   const VariableGroup & vg (_variable_groups.back());
 
   // Add each component of the group individually
   for (auto v : make_range(vars.size()))
     {
       _variables.push_back (vg(v));
       _variable_numbers[vars[v]] = curr_n_vars+v;
     }
 
   libmesh_assert_equal_to ((curr_n_vars+vars.size()), this->n_vars());
 
   // BSK - Defer this now to System::init_data() so we can detect
   // VariableGroups 12/28/2012
   // // Add the variable group to the _dof_map
   // _dof_map->add_variable_group (vg);
 
   // Return the number of the new variable
   return cast_int<unsigned int>(curr_n_vars+vars.size()-1);
 }

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

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

Definition at line 1538 of file system.C.

References add_variables().

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

◆ add_vector()

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

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

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

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

 {
   parallel_object_only();
 
   libmesh_assert(this->comm().verify(std::string(vec_name)));
   libmesh_assert(this->comm().verify(int(type)));
   libmesh_assert(this->comm().verify(projections));
 
   // Return the vector if it is already there.
   auto it = this->_vectors.find(vec_name);
   if (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
                 vec.type() = type;
             }
         }
 
       // Any upgrades are done; we're happy here.
       return vec;
     }
 
   // Otherwise build the vector
   auto pr = _vectors.emplace(vec_name, NumericVector<Number>::build(this->comm()));
   auto buf = pr.first->second.get();
   _vector_projections.emplace(vec_name, projections);
   buf->type() = type;
 
   // Vectors are primal by default
   _vector_is_adjoint.emplace(vec_name, -1);
 
   // Initialize it if necessary
   if (_is_initialized)
     {
       if (type == GHOSTED)
         {
 #ifdef LIBMESH_ENABLE_GHOSTED
           buf->init (this->n_dofs(), this->n_local_dofs(),
                      _dof_map->get_send_list(), /*fast=*/false,
                      GHOSTED);
 #else
           libmesh_error_msg("Cannot initialize ghosted vectors when they are not enabled.");
 #endif
         }
       else
         buf->init (this->n_dofs(), this->n_local_dofs(), false, type);
     }
 
   return *buf;
 }

◆ add_weighted_sensitivity_adjoint_solution()

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

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

References add_vector(), and set_vector_as_adjoint().

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

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

◆ add_weighted_sensitivity_solution()

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

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

Definition at line 1160 of file system.C.

References add_vector().

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

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

◆ adjoint_qoi_parameter_sensitivity()

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

inlinevirtual

Solves for parameter sensitivities using the adjoint method.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2558 of file system.h.

Referenced by qoi_parameter_sensitivity().

 {
   libmesh_not_implemented();
 }

◆ adjoint_solve()

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

inlinevirtual

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

Must be overridden in derived systems.

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

This method is only implemented in some derived classes.

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

Definition at line 2542 of file system.h.

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

 {
   libmesh_not_implemented();
 }

◆ assemble()

void libMesh::System::assemble ( )

virtual

Prepares matrix and _dof_map for matrix assembly.

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

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

Definition at line 549 of file system.C.

References user_assembly().

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

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

◆ assemble_qoi()

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

virtual

Calls user qoi function.

Can be overridden in derived classes.

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

Definition at line 560 of file system.C.

References user_QOI().

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

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

◆ assemble_qoi_derivative()

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

virtual

Calls user qoi derivative function.

Can be overridden in derived classes.

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

Definition at line 571 of file system.C.

References user_QOI_derivative().

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

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

◆ assemble_residual_derivatives()

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

inlinevirtual

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

 {
   libmesh_not_implemented();
 }

◆ attach_assemble_function()

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

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

Definition at line 2109 of file system.C.

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

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

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

◆ attach_assemble_object()

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

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

Definition at line 2126 of file system.C.

References _assemble_system_function, and _assemble_system_object.

Referenced by main().

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

◆ attach_constraint_function()

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

Register a user function for imposing constraints.

Definition at line 2140 of file system.C.

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

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

◆ attach_constraint_object()

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

Register a user object for imposing constraints.

Definition at line 2157 of file system.C.

References _constrain_system_function, and _constrain_system_object.

Referenced by DofMapTest::testConstraintLoopDetection().

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

◆ attach_init_function()

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

Register a user function to use in initializing the system.

Definition at line 2078 of file system.C.

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

Referenced by main().

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

◆ attach_init_object()

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

Register a user class to use to initialize the system.

Note: This is exclusive with the attach_init_function.

Definition at line 2095 of file system.C.

References _init_system_function, and _init_system_object.

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

◆ attach_QOI_derivative()

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

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

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

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

◆ attach_QOI_derivative_object()

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

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

References _qoi_evaluate_derivative_function, and _qoi_evaluate_derivative_object.

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

◆ attach_QOI_function()

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

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

Definition at line 2182 of file system.C.

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

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

◆ attach_QOI_object()

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

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

Definition at line 2200 of file system.C.

References _qoi_evaluate_function, and _qoi_evaluate_object.

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

◆ boundary_project_solution() [1/2]

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

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. If non-default Parameters are to be used, they can be provided in the parameters argument.

Definition at line 1253 of file system_projection.C.

Referenced by SystemsTest::testBoundaryProjectCube().

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

◆ boundary_project_solution() [2/2]

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

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.

Definition at line 1236 of file system_projection.C.

References fptr(), and gptr().

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

◆ boundary_project_vector() [1/2]

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

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. If non-default Parameters are to be used, they can be provided in the parameters argument.

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

Definition at line 1289 of file system_projection.C.

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

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

◆ boundary_project_vector() [2/2]

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

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.

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

Definition at line 1271 of file system_projection.C.

References fptr(), and gptr().

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

◆ calculate_norm() [1/2]

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

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

Definition at line 1672 of file system.C.

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

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

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

◆ calculate_norm() [2/2]

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

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

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

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

◆ can_add_matrices()

bool libMesh::System::can_add_matrices ( ) const

inlineprotected

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

Definition at line 1914 of file system.h.

References _matrices_initialized.

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

1914 { return !_matrices_initialized; }

libMesh::System::_matrices_initialized

bool _matrices_initialized

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

Definition: system.h:2191

◆ clear()

void libMesh::System::clear ( )

virtual

Clear all the data structures associated with the system.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::RBConstruction, libMesh::RBEIMConstruction, libMesh::ImplicitSystem, libMesh::EigenSystem, libMesh::LinearImplicitSystem, libMesh::TransientSystem< RBConstruction >, libMesh::RBConstructionBase< LinearImplicitSystem >, libMesh::RBConstructionBase< System >, libMesh::RBConstructionBase< CondensedEigenSystem >, libMesh::DifferentiableSystem, libMesh::RBSCMConstruction, libMesh::FrequencySystem, libMesh::ContinuationSystem, libMesh::ExplicitSystem, libMesh::TransientRBConstruction, and libMesh::NewmarkSystem.

Definition at line 168 of file system.C.

References _dof_map, _is_initialized, _matrices, _matrices_initialized, _variable_numbers, _variables, _vector_is_adjoint, _vector_projections, _vectors, current_local_solution, and solution.

Referenced by libMesh::ExplicitSystem::clear(), libMesh::EigenSystem::clear(), and read_header().

 {
   _variables.clear();
   _variable_numbers.clear();
   _dof_map->clear ();
   solution->clear ();
   current_local_solution->clear ();
 
   // clear any user-added vectors
   _vectors.clear();
   _vector_projections.clear();
   _vector_is_adjoint.clear();
   _is_initialized = false;
 
   // clear any user-added matrices
   _matrices.clear();
   _matrices_initialized = false;
 }

◆ comm()

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

inlineinherited

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

Definition at line 97 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

98 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:120

◆ compare()

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

virtual

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

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

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

◆ current_solution()

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

Returns: The current solution for the specified global DOF.

Definition at line 157 of file system.C.

References _dof_map, and current_local_solution.

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

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

◆ deactivate()

void libMesh::System::deactivate ( )

inline

Deactivates the system.

Only active systems are solved.

Definition at line 2325 of file system.h.

References _active.

 {
   _active = false;
 }

◆ disable_cache()

void libMesh::System::disable_cache ( )

inlinevirtual

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

References assemble_before_solve.

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

2513 { assemble_before_solve = true; }

libMesh::System::assemble_before_solve

bool assemble_before_solve

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

Definition: system.h:1527

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = false;
   return;
 }

◆ discrete_var_norm()

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

private

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

Definition at line 1653 of file system.C.

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

Referenced by calculate_norm().

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

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Definition at line 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = true;
   return;
 }

◆ forward_qoi_parameter_sensitivity()

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

inlinevirtual

Solves for parameter sensitivities using the forward method.

This method is only implemented in some derived classes.

Reimplemented in libMesh::ImplicitSystem.

Definition at line 2567 of file system.h.

Referenced by qoi_parameter_sensitivity().

 {
   libmesh_not_implemented();
 }

◆ get_adjoint_rhs() [1/2]

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

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

References get_vector().

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

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

◆ get_adjoint_rhs() [2/2]

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

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

Definition at line 1265 of file system.C.

References get_vector().

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

◆ get_adjoint_solution() [1/2]

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

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

Definition at line 1193 of file system.C.

References get_vector().

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

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

◆ get_adjoint_solution() [2/2]

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

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

Definition at line 1203 of file system.C.

References get_vector().

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

◆ get_all_variable_numbers()

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

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

Definition at line 1565 of file system.C.

References _variable_numbers, and n_vars().

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

 {
   all_variable_numbers.resize(n_vars());
 
   unsigned int count = 0;
   for (auto vn : _variable_numbers)
     all_variable_numbers[count++] = vn.second;
 }

◆ get_constraint_object()

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

Return the user object for imposing constraints.

Definition at line 2174 of file system.C.

References _constrain_system_object.

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

◆ get_dof_map() [1/2]

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

inline

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

Definition at line 2293 of file system.h.

References _dof_map.

Referenced by libMesh::__libmesh_petsc_diff_solver_jacobian(), libMesh::__libmesh_petsc_diff_solver_residual(), libMesh::ExactSolution::_compute_error(), libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::DifferentiableSystem::add_dot_var_dirichlet_bcs(), libMesh::HPCoarsenTest::add_projection(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::ImplicitSystem::adjoint_solve(), libMesh::NewmarkSolver::advance_timestep(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::EquationSystems::allgather(), libMesh::TransientRBConstruction::allocate_data_structures(), libMesh::RBConstruction::allocate_data_structures(), alternative_fe_assembly(), assemble(), LinearElasticity::assemble(), assemble_1D(), AssembleOptimization::assemble_A_and_F(), assemble_and_solve(), assemble_biharmonic(), assemble_divgrad(), assemble_elasticity(), assemble_ellipticdg(), assemble_func(), assemble_helmholtz(), assemble_laplace(), assemble_mass(), assemble_matrices(), assemble_matrix_and_rhs(), assemble_poisson(), assemble_SchroedingerEquation(), assemble_shell(), assemble_stokes(), assemble_wave(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::PetscDMWrapper::build_sf(), calculate_norm(), compute_jacobian(), compute_residual(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), libMesh::Problem_Interface::computeF(), libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), MyConstraint::constrain(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_nodal_solution(), libMesh::ExodusII_IO::copy_scalar_solution(), libMesh::Nemesis_IO::copy_scalar_solution(), DMCreateDomainDecomposition_libMesh(), DMCreateFieldDecomposition_libMesh(), DMlibMeshFunction(), DMlibMeshJacobian(), DMlibMeshSetSystem_libMesh(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), fe_assembly(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), get_info(), libMesh::SystemSubsetBySubdomain::init(), libMesh::PetscDMWrapper::init_and_attach_petscdm(), libMesh::SecondOrderUnsteadySolver::init_data(), libMesh::UnsteadySolver::init_data(), HeatSystem::init_data(), SimpleRBConstruction::init_data(), LaplaceSystem::init_dirichlet_bcs(), libMesh::FEMContext::init_internal_data(), libMesh::EigenSystem::init_matrices(), init_matrices(), libMesh::CondensedEigenSystem::initialize_condensed_dofs(), libMesh::OptimizationSystem::initialize_equality_constraints_storage(), libMesh::OptimizationSystem::initialize_inequality_constraints_storage(), LaplaceYoung::jacobian(), LargeDeformationElasticity::jacobian(), late_matrix_init(), libMesh::libmesh_petsc_snes_fd_residual(), libMesh::libmesh_petsc_snes_jacobian(), libMesh::libmesh_petsc_snes_mffd_residual(), libMesh::libmesh_petsc_snes_residual(), libMesh::libmesh_petsc_snes_residual_helper(), local_dof_indices(), AssembleOptimization::lower_and_upper_bounds(), main(), libMesh::DofMap::max_constraint_error(), LinearElasticityWithContact::move_mesh(), libMesh::DGFEMContext::neighbor_side_fe_reinit(), libMesh::UnsteadySolver::old_nonlinear_solution(), libMesh::SecondOrderUnsteadySolver::old_solution_accel(), libMesh::SecondOrderUnsteadySolver::old_solution_rate(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::RBSCMConstruction::perform_SCM_greedy(), periodic_bc_test_poisson(), libMesh::petsc_auto_fieldsplit(), libMesh::ErrorVector::plot_error(), point_gradient(), point_hessian(), point_value(), libMesh::FEMContext::pre_fe_reinit(), libMesh::InterMeshProjection::project_system_vectors(), re_update(), read_parallel_data(), read_SCALAR_dofs(), libMesh::SecondOrderUnsteadySolver::reinit(), libMesh::UnsteadySolver::reinit(), reinit(), reinit_constraints(), libMesh::EquationSystems::reinit_solutions(), LaplaceYoung::residual(), LargeDeformationElasticity::residual(), LinearElasticityWithContact::residual_and_jacobian(), libMesh::UnsteadySolver::retrieve_timestep(), OverlappingAlgebraicGhostingTest::run_ghosting_test(), OverlappingCouplingGhostingTest::run_sparsity_pattern_test(), libMesh::HPCoarsenTest::select_refinement(), libMesh::ImplicitSystem::sensitivity_solve(), libMesh::RBConstruction::set_context_solution_vec(), libMesh::PetscDMWrapper::set_point_range_in_section(), set_system_parameters(), FETestBase< order, family, elem_type, 1 >::setUp(), SolidSystem::side_time_derivative(), libMesh::NewtonSolver::solve(), libMesh::PetscDiffSolver::solve(), libMesh::EigenSystem::solve(), libMesh::RBConstruction::solve_for_matrix_and_rhs(), ConstraintOperatorTest::test1DCoarseningNewNodes(), ConstraintOperatorTest::test1DCoarseningOperator(), MeshfunctionDFEM::test_mesh_function_dfem(), MeshfunctionDFEM::test_mesh_function_dfem_grad(), MeshFunctionTest::test_p_level(), MeshFunctionTest::test_subdomain_id_sets(), SystemsTest::testBlockRestrictedVarNDofs(), DofMapTest::testConstraintLoopDetection(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), EquationSystemsTest::testDisableDefaultGhosting(), SystemsTest::testDofCouplingWithVarGroups(), DofMapTest::testDofOwner(), MeshInputTest::testDynaReadPatch(), MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData(), MeshAssignTest::testMeshMoveAssign(), PeriodicBCTest::testPeriodicBC(), SystemsTest::testPostInitAddVectorTypeChange(), SystemsTest::testProjectCubeWithMeshFunction(), SystemsTest::testProjectMatrix1D(), SystemsTest::testProjectMatrix2D(), SystemsTest::testProjectMatrix3D(), InfFERadialTest::testRefinement(), EquationSystemsTest::testSelectivePRefine(), BoundaryInfoTest::testShellFaceConstraints(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::UnsteadySolver::update(), libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve(), libMesh::ImplicitSystem::weighted_sensitivity_solve(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), write_parallel_data(), libMesh::EnsightIO::write_scalar_ascii(), write_SCALAR_dofs(), libMesh::EnsightIO::write_vector_ascii(), and libMesh::RBConstruction::zero_constrained_dofs_on_vector().

 {
   return *_dof_map;
 }

◆ get_dof_map() [2/2]

DofMap & libMesh::System::get_dof_map ( )

inline

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

Definition at line 2301 of file system.h.

References _dof_map.

 {
   return *_dof_map;
 }

◆ get_equation_systems() [1/2]

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

inline

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

Definition at line 730 of file system.h.

References _equation_systems.

730 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:2119

◆ get_equation_systems() [2/2]

EquationSystems& libMesh::System::get_equation_systems ( )

inline

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

Definition at line 735 of file system.h.

References _equation_systems.

735 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:2119

◆ get_info() [1/2]

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

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

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

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

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

◆ get_info() [2/2]

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

Returns: A string containing information about the system.

Definition at line 1988 of file system.C.

References libMesh::ParallelObject::comm(), libMesh::FEType::family, get_dof_map(), libMesh::DofMap::get_info(), libMesh::FEType::inf_map, libMesh::make_range(), TIMPI::Communicator::max(), n_constrained_dofs(), n_dofs(), n_local_constrained_dofs(), n_local_dofs(), n_matrices(), n_variable_groups(), libMesh::VariableGroup::n_variables(), n_vectors(), libMesh::VariableGroup::name(), name(), number(), libMesh::FEType::order, libMesh::FEType::radial_family, libMesh::FEType::radial_order, system_type(), libMesh::Variable::type(), libMesh::DofMap::variable_group(), and variable_group().

 {
   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';
 
   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
   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
 
   oss << "    " << "n_vectors()="  << this->n_vectors()  << '\n';
   oss << "    " << "n_matrices()="  << this->n_matrices()  << '\n';
   //   oss << "    " << "n_additional_matrices()=" << this->n_additional_matrices() << '\n';
 
   oss << this->get_dof_map().get_info();
 
   return oss.str();
 }

◆ get_matrix() [1/2]

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

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

Definition at line 1073 of file system.C.

References _matrices.

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

 {
   return *libmesh_map_find(_matrices, mat_name);
 }

◆ get_matrix() [2/2]

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

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

Definition at line 1080 of file system.C.

References _matrices.

 {
   return *libmesh_map_find(_matrices, mat_name);
 }

◆ get_mesh() [1/2]

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

inline

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

Definition at line 2277 of file system.h.

References _mesh.

Referenced by libMesh::ExactSolution::_compute_error(), LinearElasticityWithContact::add_contact_edge_elements(), libMesh::PetscDMWrapper::add_dofs_to_section(), libMesh::HPCoarsenTest::add_projection(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), AssembleOptimization::assemble_A_and_F(), libMesh::FEMSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::FEMSystem::assembly(), AssemblyA0::boundary_assembly(), AssemblyA1::boundary_assembly(), AssemblyF0::boundary_assembly(), AssemblyF1::boundary_assembly(), AssemblyA2::boundary_assembly(), AssemblyF2::boundary_assembly(), calculate_norm(), compute_jacobian(), compute_residual(), LinearElasticityWithContact::compute_stresses(), libMesh::RBEIMEvaluation::distribute_bfs(), DMCreateDomainDecomposition_libMesh(), DMCreateFieldDecomposition_libMesh(), DMlibMeshSetSystem_libMesh(), SolidSystem::element_time_derivative(), HeatSystem::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::PatchRecoveryErrorEstimator::estimate_error(), libMesh::WeightedPatchRecoveryErrorEstimator::estimate_error(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::AdjointResidualErrorEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::GenericProjector(), LinearElasticityWithContact::get_least_and_max_gap_function(), libMesh::SystemSubsetBySubdomain::init(), libMesh::PetscDMWrapper::init_and_attach_petscdm(), libMesh::RBEIMConstruction::init_context(), SolidSystem::init_data(), init_data(), init_matrices(), LinearElasticityWithContact::initialize_contact_load_paths(), libMesh::RBEIMConstruction::initialize_qp_data(), local_dof_indices(), libMesh::DofMap::max_constraint_error(), libMesh::FEMSystem::mesh_position_get(), libMesh::FEMSystem::mesh_position_set(), LinearElasticityWithContact::move_mesh(), libMesh::RBEIMEvaluation::node_distribute_bfs(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::petsc_auto_fieldsplit(), point_gradient(), point_hessian(), point_value(), libMesh::FEMSystem::postprocess(), libMesh::RBParametrizedFunction::preevaluate_parametrized_function_on_mesh(), libMesh::RBParametrizedFunction::preevaluate_parametrized_function_on_mesh_sides(), libMesh::RBEIMEvaluation::project_qp_data_map_onto_system(), read_header(), libMesh::RBEvaluation::read_in_vectors_from_multiple_files(), read_legacy_data(), read_parallel_data(), read_serialized_vector(), read_serialized_vectors(), 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::PetscDMWrapper::set_point_range_in_section(), libMesh::RBEIMEvaluation::side_distribute_bfs(), SolidSystem::side_time_derivative(), libMesh::PetscDiffSolver::solve(), MeshAssignTest::testMeshMoveAssign(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), libMesh::TransientRBConstruction::truth_solve(), libMesh::RBConstruction::truth_solve(), write_header(), libMesh::RBEvaluation::write_out_vectors(), write_parallel_data(), write_serialized_vector(), write_serialized_vectors(), and zero_variable().

 {
   return _mesh;
 }

◆ get_mesh() [2/2]

MeshBase & libMesh::System::get_mesh ( )

inline

Returns: A reference to this systems's _mesh.

Definition at line 2285 of file system.h.

References _mesh.

 {
   return _mesh;
 }

◆ get_project_with_constraints()

bool libMesh::System::get_project_with_constraints ( )

inline

Setter and getter functions for project_with_constraints boolean.

Definition at line 1775 of file system.h.

References project_with_constraints.

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

   {
     return project_with_constraints;
   }

◆ get_qoi_error_estimate_value()

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

Definition at line 2361 of file system.C.

References libMesh::libmesh_assert(), and qoi_error_estimates.

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

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

◆ get_qoi_value()

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

Definition at line 2334 of file system.C.

References libMesh::libmesh_assert(), and qoi.

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

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

◆ get_qoi_values()

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

Returns a copy of qoi, not a reference.

Definition at line 2341 of file system.C.

References qoi.

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

 {
   return this->qoi;
 }

◆ get_sensitivity_rhs() [1/2]

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

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

References get_vector().

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

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

◆ get_sensitivity_rhs() [2/2]

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

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

Definition at line 1295 of file system.C.

References get_vector().

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

◆ get_sensitivity_solution() [1/2]

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

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

Definition at line 1140 of file system.C.

References get_vector().

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

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

◆ get_sensitivity_solution() [2/2]

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

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

Definition at line 1150 of file system.C.

References get_vector().

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

◆ get_vector() [1/4]

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

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

References _vectors.

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

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

◆ get_vector() [2/4]

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

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

References _vectors.

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

◆ get_vector() [3/4]

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

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

Definition at line 932 of file system.C.

References _vectors, and vectors_begin().

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

◆ get_vector() [4/4]

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

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

Definition at line 945 of file system.C.

References _vectors, and vectors_begin().

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

◆ get_weighted_sensitivity_adjoint_solution() [1/2]

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

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

References get_vector().

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

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

◆ get_weighted_sensitivity_adjoint_solution() [2/2]

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

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

References get_vector().

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

◆ get_weighted_sensitivity_solution() [1/2]

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

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

Definition at line 1167 of file system.C.

References get_vector().

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

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

◆ get_weighted_sensitivity_solution() [2/2]

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

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

Definition at line 1174 of file system.C.

References get_vector().

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

◆ has_constraint_object()

bool libMesh::System::has_constraint_object ( ) const

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

References _constrain_system_object.

 {
   return _constrain_system_object != nullptr;
 }

◆ has_variable()

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

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

Definition at line 1550 of file system.C.

References _variable_numbers.

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

 {
   return _variable_numbers.count(var);
 }

◆ have_matrix()

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

inline

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

Definition at line 1860 of file system.h.

References _matrices.

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

1860 { return _matrices.count(mat_name); };

libMesh::System::_matrices

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

Some systems need an arbitrary number of matrices.

Definition: system.h:2181

◆ have_vector()

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

inline

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

Definition at line 2469 of file system.h.

References _vectors.

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

◆ hide_output()

bool& libMesh::System::hide_output ( )

inline

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

References _hide_output.

1790 { 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:2248

◆ identify_variable_groups() [1/2]

bool libMesh::System::identify_variable_groups ( ) const

inline

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

Definition at line 2445 of file system.h.

References _identify_variable_groups.

Referenced by add_variable(), and add_variables().

 {
   return _identify_variable_groups;
 }

◆ identify_variable_groups() [2/2]

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

inline

Toggle automatic VariableGroup identification.

Definition at line 2453 of file system.h.

References _identify_variable_groups.

 {
   _identify_variable_groups = ivg;
 }

◆ increment_constructor_count()

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

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

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

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

◆ increment_destructor_count()

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

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

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

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

◆ init()

void libMesh::System::init ( )

Initializes degrees of freedom on the current mesh.

Sets the

Definition at line 189 of file system.C.

References _basic_system_only, init_data(), is_initialized(), libMesh::libmesh_assert(), n_vars(), and user_initialization().

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

◆ init_data()

void libMesh::System::init_data ( )

protectedvirtual

Initializes the data for the system.

Note: This is called before any user-supplied initialization function so that all required storage will be available.

Reimplemented in libMesh::DifferentiableSystem, libMesh::ContinuationSystem, libMesh::FEMSystem, libMesh::OptimizationSystem, libMesh::FrequencySystem, libMesh::RBConstructionBase< LinearImplicitSystem >, libMesh::RBConstructionBase< System >, libMesh::RBConstructionBase< CondensedEigenSystem >, SecondOrderScalarSystemSecondOrderTimeSolverBase, SimpleRBConstruction, FirstOrderScalarSystemBase, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, libMesh::LinearImplicitSystem, HeatSystem, SimpleRBConstruction, ElasticityRBConstruction, CoupledSystem, SimpleEIMConstruction, L2System, SimpleEIMConstruction, ElasticitySystem, ElasticitySystem, HeatSystem, LaplaceSystem, CurlCurlSystem, LaplaceSystem, PoissonSystem, LaplaceSystem, LaplaceSystem, CurlCurlSystem, SolidSystem, NavierSystem, and HeatSystem.

Definition at line 216 of file system.C.

References _basic_system_only, _dof_map, _is_initialized, _matrices, _vectors, add_matrices(), current_local_solution, get_mesh(), libMesh::GHOSTED, init_matrices(), libMesh::libmesh_assert(), libMesh::libmesh_ignore(), libMesh::make_range(), mesh, n_dofs(), n_local_dofs(), n_variable_groups(), libMesh::PARALLEL, reinit_constraints(), libMesh::SERIAL, solution, and variable_group().

Referenced by init(), libMesh::LinearImplicitSystem::init_data(), libMesh::OptimizationSystem::init_data(), libMesh::DifferentiableSystem::init_data(), and reinit_mesh().

 {
   parallel_object_only();
 
   MeshBase & mesh = this->get_mesh();
 
   // Add all variable groups to our underlying DofMap
   unsigned int n_dof_map_vg = _dof_map->n_variable_groups();
   for (auto vg : make_range(this->n_variable_groups()))
     {
       const VariableGroup & group = this->variable_group(vg);
       if (vg < n_dof_map_vg)
         libmesh_assert(group == _dof_map->variable_group(vg));
       else
         _dof_map->add_variable_group(group);
     }
 
   // Distribute the degrees of freedom on the mesh
   auto total_dofs = _dof_map->distribute_dofs (mesh);
 
   // Throw an error if the total number of DOFs is not capable of
   // being indexed by our solution vector.
   auto max_allowed_id = solution->max_allowed_id();
   libmesh_error_msg_if(total_dofs > max_allowed_id,
                        "Cannot allocate a NumericVector with " << total_dofs << " degrees of freedom. "
                        "The vector can only index up to " << max_allowed_id << " entries.");
 
   // Recreate any user or internal constraints
   this->reinit_constraints();
 
   // And clean up the send_list before we first use it
   _dof_map->prepare_send_list();
 
   // Resize the solution conformal to the current mesh
   solution->init (this->n_dofs(), this->n_local_dofs(), false, PARALLEL);
 
   // Resize the current_local_solution for the current mesh
 #ifdef LIBMESH_ENABLE_GHOSTED
   current_local_solution->init (this->n_dofs(), this->n_local_dofs(),
                                 _dof_map->get_send_list(), /*fast=*/false,
                                 GHOSTED);
 #else
   current_local_solution->init (this->n_dofs(), false, SERIAL);
 #endif
 
   // from now on, adding additional vectors or variables can't be done
   // without immediately initializing them
   _is_initialized = true;
 
   // initialize & zero other vectors, if necessary
   for (auto & [vec_name, vec] : _vectors)
     {
       libmesh_ignore(vec_name); // spurious warning from old gcc
       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 if (type == SERIAL)
         {
           vec->init (this->n_dofs(), false, type);
         }
       else
         {
           libmesh_assert_equal_to(type, PARALLEL);
           vec->init (this->n_dofs(), this->n_local_dofs(), false, type);
         }
     }
 
   // Add matrices
   this->add_matrices();
 
   // Clear any existing matrices
   for (auto & pr : _matrices)
     pr.second->clear();
 
   // Initialize the matrices for the system
   if (!_basic_system_only)
    this->init_matrices();
 }

◆ init_matrices()

void libMesh::System::init_matrices ( )

protectedvirtual

Initializes the matrices associated with this system.

Reimplemented in libMesh::EigenSystem.

Definition at line 326 of file system.C.

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

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

 {
   parallel_object_only();
 
   // No matrices to init
   if (_matrices.empty())
     {
       // any future matrices to be added will need their own
       // initialization
       _matrices_initialized = true;
 
       return;
     }
 
   // Check for quick return in case the first matrix
   // (and by extension all the matrices) has already
   // been initialized
   if (_matrices.begin()->second->initialized())
     {
       libmesh_assert(_matrices_initialized);
       return;
     }
 
   _matrices_initialized = true;
 
   // Tell the matrices about the dof map, and vice versa
   for (auto & pr : _matrices)
     {
       SparseMatrix<Number> & m = *(pr.second);
       libmesh_assert (!m.initialized());
 
       // We want to allow repeated init() on systems, but we don't
       // want to attach the same matrix to the DofMap twice
       if (!this->get_dof_map().is_attached(m))
         this->get_dof_map().attach_matrix(m);
     }
 
   // Compute the sparsity pattern for the current
   // mesh and DOF distribution.  This also updates
   // additional matrices, \p DofMap now knows them
   this->get_dof_map().compute_sparsity(this->get_mesh());
 
   // Initialize matrices and set to zero
   for (auto & pr : _matrices)
     {
       pr.second->init(_matrix_types[pr.first]);
       pr.second->zero();
     }
 }

◆ init_qois()

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

Accessors for qoi and qoi_error_estimates vectors.

Definition at line 2319 of file system.C.

References n_qois(), qoi, and qoi_error_estimates.

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

 {
   qoi.resize(n_qois);
   qoi_error_estimates.resize(n_qois);
 }

◆ is_adjoint_already_solved()

bool libMesh::System::is_adjoint_already_solved ( ) const

inline

Accessor for the adjoint_already_solved boolean.

Definition at line 406 of file system.h.

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

407 { 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:2242

◆ is_initialized()

bool libMesh::System::is_initialized ( )

inline

Returns: true iff this system has been initialized.

Definition at line 2333 of file system.h.

References _is_initialized.

Referenced by add_variable(), add_variables(), and init().

 {
   return _is_initialized;
 }

◆ late_matrix_init()

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

private

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

Definition at line 1019 of file system.C.

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

Referenced by add_matrix().

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

◆ local_dof_indices()

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

Definition at line 1575 of file system.C.

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

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

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

◆ n_active_dofs()

dof_id_type libMesh::System::n_active_dofs ( ) const

inline

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

Definition at line 2461 of file system.h.

References n_constrained_dofs(), and n_dofs().

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

◆ n_components()

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

inline

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

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

Referenced by add_variables().

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

◆ n_constrained_dofs()

dof_id_type libMesh::System::n_constrained_dofs ( ) const

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

Definition at line 120 of file system.C.

References _dof_map.

Referenced by get_info(), n_active_dofs(), libMesh::EigenSystem::solve(), and BoundaryInfoTest::testShellFaceConstraints().

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

◆ n_dofs()

dof_id_type libMesh::System::n_dofs ( ) const

Returns: The number of degrees of freedom in the system

Definition at line 113 of file system.C.

References _dof_map.

 {
   return _dof_map->n_dofs();
 }

◆ n_local_constrained_dofs()

dof_id_type libMesh::System::n_local_constrained_dofs ( ) const

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

Definition at line 135 of file system.C.

References _dof_map.

Referenced by get_info().

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

◆ n_local_dofs()

dof_id_type libMesh::System::n_local_dofs ( ) const

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

Definition at line 150 of file system.C.

References _dof_map, and libMesh::ParallelObject::processor_id().

 {
   return _dof_map->n_dofs_on_processor (this->processor_id());
 }

◆ n_matrices()

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

inline

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

Definition at line 2594 of file system.h.

References _matrices.

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

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

◆ n_objects()

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

inlinestaticinherited

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

Definition at line 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 103 of file parallel_object.h.

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

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

◆ n_qois()

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

inline

Number of currently active quantities of interest.

Definition at line 2516 of file system.h.

References qoi, and qoi_error_estimates.

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

 {
 #ifndef LIBMESH_ENABLE_DEPRECATED
   libmesh_assert_equal_to(this->qoi.size(), this->qoi_error_estimates.size());
 #endif
 
   return cast_int<unsigned int>(this->qoi.size());
 }

◆ n_variable_groups()

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

inline

Returns: The number of VariableGroup variable groups in the system

Definition at line 2357 of file system.h.

References _variable_groups.

Referenced by add_variable(), add_variables(), libMesh::FEMSystem::assembly(), get_info(), and init_data().

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

◆ n_vars()

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

inline

Returns: The number of variables in the system

Definition at line 2349 of file system.h.

References _variables.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::PetscDMWrapper::add_dofs_helper(), libMesh::DiffContext::add_localized_vector(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), add_variable(), add_variables(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::FEMContext::attach_quadrature_rules(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::PetscDMWrapper::build_section(), calculate_norm(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), libMesh::DGFEMContext::DGFEMContext(), libMesh::DiffContext::DiffContext(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::AdjointResidualErrorEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::ErrorEstimator::estimate_errors(), libMesh::ExactSolution::ExactSolution(), libMesh::FEMContext::find_hardest_fe_type(), libMesh::EquationSystems::find_variable_numbers(), get_all_variable_numbers(), init(), libMesh::PetscDMWrapper::init_and_attach_petscdm(), libMesh::FEMSystem::init_context(), libMesh::RBEIMConstruction::init_context(), libMesh::FEMContext::init_internal_data(), libMesh::DifferentiablePhysics::init_physics(), AssemblyA0::interior_assembly(), AssemblyA1::interior_assembly(), AssemblyA2::interior_assembly(), InnerProductAssembly::interior_assembly(), main(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), output_norms(), libMesh::petsc_auto_fieldsplit(), libMesh::FEMContext::pre_fe_reinit(), libMesh::RBEIMEvaluation::project_qp_data_map_onto_system(), libMesh::InterMeshProjection::project_system_vectors(), re_update(), read_legacy_data(), read_parallel_data(), read_serialized_blocked_dof_objects(), read_serialized_vector(), read_serialized_vectors(), reinit_mesh(), libMesh::HPCoarsenTest::select_refinement(), libMesh::PetscDMWrapper::set_point_range_in_section(), libMesh::SystemSubsetBySubdomain::set_var_nums(), OverlappingTestBase::setup_coupling_matrix(), SystemsTest::testDofCouplingWithVarGroups(), SlitMeshRefinedSystemTest::testRestart(), SlitMeshRefinedSystemTest::testSystem(), write_header(), write_parallel_data(), write_serialized_blocked_dof_objects(), write_serialized_vector(), write_serialized_vectors(), and zero_variable().

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

◆ n_vectors()

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

inline

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

References _vectors.

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

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

◆ name()

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

inline

Returns: The system name.

Definition at line 2261 of file system.h.

References _sys_name.

Referenced by 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(), get_info(), libMesh::ImplicitSystem::get_linear_solver(), libMesh::NewtonSolver::init(), libMesh::TimeSolver::init_data(), main(), output_norms(), libMesh::petsc_auto_fieldsplit(), libMesh::RBSCMConstruction::print_info(), libMesh::RBEIMConstruction::print_info(), libMesh::RBConstruction::print_info(), libMesh::TimeSolver::reinit(), libMesh::PetscDiffSolver::setup_petsc_data(), libMesh::FrequencySystem::solve(), libMesh::LinearImplicitSystem::solve(), libMesh::NonlinearImplicitSystem::solve(), libMesh::RBConstruction::truth_solve(), user_assembly(), user_constrain(), user_initialization(), user_QOI(), user_QOI_derivative(), variable_number(), write_header(), write_parallel_data(), and write_serialized_data().

 {
   return _sys_name;
 }

◆ number()

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

inline

Returns: The system number.

Definition at line 2269 of file system.h.

References _sys_number.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::PetscDMWrapper::add_dofs_helper(), assemble_matrix_and_rhs(), assemble_shell(), libMesh::EquationSystems::build_parallel_solution_vector(), 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(), get_info(), main(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), read_legacy_data(), read_parallel_data(), read_serialized_blocked_dof_objects(), LinearElasticityWithContact::residual_and_jacobian(), SolidSystem::save_initial_mesh(), libMesh::HPCoarsenTest::select_refinement(), libMesh::PetscDMWrapper::set_point_range_in_section(), MeshInputTest::testCopyElementVectorImpl(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::MeshfreeSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), libMesh::DTKAdapter::update_variable_values(), write_parallel_data(), write_serialized_blocked_dof_objects(), and zero_variable().

 {
   return _sys_number;
 }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

System& libMesh::System::operator= ( System && )

delete

◆ 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

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

Definition at line 2498 of file system.C.

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

Referenced by line_print(), and point_gradient().

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

◆ point_gradient() [2/4]

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

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

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

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

◆ point_gradient() [3/4]

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

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

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

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

◆ point_gradient() [4/4]

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

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

References point_gradient().

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

◆ point_hessian() [1/4]

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

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

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

Referenced by point_hessian().

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

◆ point_hessian() [2/4]

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

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

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

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

◆ point_hessian() [3/4]

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

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

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

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

◆ point_hessian() [4/4]

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

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

References point_hessian().

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

◆ point_value() [1/4]

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

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

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

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

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

◆ point_value() [2/4]

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

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

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

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

◆ point_value() [3/4]

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

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

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

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

◆ point_value() [4/4]

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

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

References point_value().

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

◆ print_info()

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

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

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

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

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 114 of file parallel_object.h.

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

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

TIMPI::Communicator::rank

processor_id_type rank() const

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:120

◆ project_solution() [1/3]

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

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. If non-default Parameters are to be used, they can be provided in the parameters argument.

Definition at line 1041 of file system_projection.C.

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

 {
   this->project_vector(*solution, f, g);
 
   solution->localize(*current_local_solution, _dof_map->get_send_list());
 }

◆ project_solution() [2/3]

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

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. If non-default Parameters are to be used, they can be provided in the parameters argument.

Definition at line 1054 of file system_projection.C.

 {
   this->project_vector(*solution, f, g);
 
   solution->localize(*current_local_solution, _dof_map->get_send_list());
 }

◆ project_solution() [3/3]

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

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

Definition at line 1027 of file system_projection.C.

References fptr(), and gptr().

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

◆ project_solution_on_reinit()

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

inline

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

References _solution_projection.

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

822 { 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:2198

◆ project_vector() [1/5]

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

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. If non-default Parameters are to be used, they can be provided in the parameters argument.

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

Definition at line 1082 of file system_projection.C.

References libMesh::libmesh_assert().

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

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

◆ project_vector() [2/5]

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

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. If non-default Parameters are to be used, they can be provided in the parameters argument.

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

Definition at line 1108 of file system_projection.C.

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

 {
   LOG_SCOPE ("project_fem_vector()", "System");
 
   libmesh_assert (f);
 
   ConstElemRange active_local_range
     (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(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);
     }
   else
     {
       FEMProjector projector(*this, fw, nullptr, setter, vars);
       projector.project(active_local_range);
     }
 
   // 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 : make_range(this->n_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)
         if (elem->type() == NODEELEM)
           for (auto rational_var : rational_vars)
             if (rational_var->active_on_subdomain(elem->subdomain_id()))
               {
                 using_spline_bases = true;
                 goto checked_on_splines;
               }
     }
 
 checked_on_splines:
 
   // Not every processor may have a NodeElem, especially while
   // we're not partitioning them efficiently yet.
   this->comm().max(using_spline_bases);
 
   if (using_spline_bases)
     this->solve_for_unconstrained_dofs(new_vector, is_adjoint);
 
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
   if (is_adjoint == -1)
     this->get_dof_map().enforce_constraints_exactly(*this, &new_vector);
   else if (is_adjoint >= 0)
     this->get_dof_map().enforce_adjoint_constraints_exactly(new_vector,
                                                             is_adjoint);
 #else
   libmesh_ignore(is_adjoint);
 #endif
 }

◆ project_vector() [3/5]

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

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.

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

Definition at line 1067 of file system_projection.C.

References fptr(), and gptr().

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

◆ project_vector() [4/5]

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

protected

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

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

Definition at line 247 of file system_projection.C.

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

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

◆ project_vector() [5/5]

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

protected

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 265 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;
 
   ConstElemRange active_local_elem_range
     (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_elem_range,
                                 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_elem_range,
                                 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(n_variables);
       std::iota(vars.begin(), vars.end(), 0);
       std::vector<unsigned int> regular_vars, vector_vars;
       for (auto var : vars)
       {
         if (FEInterface::field_type(this->variable_type(var)) == TYPE_SCALAR)
           regular_vars.push_back(var);
         else
           vector_vars.push_back(var);
       }
 
       VectorSetAction<Number> setter(new_vector);
 
       if (!regular_vars.empty())
         {
           // Use a typedef to make the calling sequence for parallel_for() a bit more readable
           typedef
             GenericProjector<OldSolutionValue<Number,   &FEMContext::point_value>,
                              OldSolutionValue<Gradient, &FEMContext::point_gradient>,
                              Number, VectorSetAction<Number>> FEMProjector;
 
           OldSolutionValue<Number,   &FEMContext::point_value>
             f(*this, old_vector, &regular_vars);
           OldSolutionValue<Gradient, &FEMContext::point_gradient>
             g(*this, old_vector, &regular_vars);
 
           FEMProjector projector(*this, f, &g, setter, regular_vars);
           projector.project(active_local_elem_range);
         }
 
       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_elem_range);
         }
 
       // 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 : 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);
                 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);
 
 #endif // #ifdef LIBMESH_ENABLE_AMR
 }

◆ projection_matrix()

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

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

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

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

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

◆ prolong_vectors()

void libMesh::System::prolong_vectors ( )

virtual

Prolong vectors after the mesh has refined.

Definition at line 436 of file system.C.

References restrict_vectors().

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

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

◆ qoi_parameter_hessian()

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

inlinevirtual

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

inlinevirtual

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

virtual

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

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

 {
   // Forward sensitivities are more efficient for Nq > Np
   if (qoi_indices.size(*this) > parameters.size())
     forward_qoi_parameter_sensitivity(qoi_indices, parameters, 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, sensitivities);
 }

◆ re_update()

void libMesh::System::re_update ( )

virtual

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

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

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

◆ read_header()

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

Reads the basic data header for this System.

Definition at line 97 of file system_io.C.

References _additional_data_written, _written_var_indices, add_variable(), add_vector(), TIMPI::Communicator::broadcast(), clear(), libMesh::ParallelObject::comm(), libMesh::Xdr::data(), libMesh::FEType::family, 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(), variable_number(), libMesh::Xdr::version(), and libMesh::XYZ.

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

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

◆ read_legacy_data()

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

Reads additional data, namely vectors, for this System.

Definition at line 302 of file system_io.C.

References _additional_data_written, _vectors, _written_var_indices, TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), libMesh::Xdr::data(), get_mesh(), libMesh::DofObject::invalid_id, libMesh::libmesh_assert(), libMesh::make_range(), n_dofs(), n_vars(), number(), libMesh::ParallelObject::processor_id(), libMesh::Xdr::reading(), solution, and libMesh::zero.

 {
   libmesh_deprecated();
 
   // This method implements the output 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.)
   libmesh_assert (io.reading());
 
   // directly-read and reordered buffers, declared here for reuse
   // without heap juggling.
   std::vector<Number> global_vector;
   std::vector<Number> reordered_vector;
 
   auto reorder_vector_into =
     [this, &global_vector, &reordered_vector]
     (NumericVector<Number> & vec)
   {
     this->comm().broadcast(global_vector);
 
     // If we have been reading multiple vectors, they should all be
     // the same size.
     libmesh_assert (reordered_vector.empty() ||
                     reordered_vector.size() == global_vector.size());
 
     // Remember that the stored vector is node-major.
     // We need to put it into whatever application-specific
     // ordering we may have using the dof_map.
     reordered_vector.resize(global_vector.size());
 
     //libMesh::out << "global_vector.size()=" << global_vector.size() << std::endl;
     //libMesh::out << "this->n_dofs()=" << this->n_dofs() << std::endl;
 
     libmesh_assert_equal_to (global_vector.size(), this->n_dofs());
 
     dof_id_type cnt=0;
 
     const unsigned int sys = this->number();
     const unsigned int nv  = cast_int<unsigned int>
       (this->_written_var_indices.size());
     libmesh_assert_less_equal (nv, this->n_vars());
 
     for (unsigned int data_var=0; data_var<nv; data_var++)
       {
         const unsigned int var = _written_var_indices[data_var];
 
         // First reorder the nodal DOF values
         for (auto & node : this->get_mesh().node_ptr_range())
           for (auto index : make_range(node->n_comp(sys,var)))
             {
               libmesh_assert_not_equal_to (node->dof_number(sys, var, index),
                                            DofObject::invalid_id);
 
               libmesh_assert_less (cnt, global_vector.size());
 
               reordered_vector[node->dof_number(sys, var, index)] =
                 global_vector[cnt++];
             }
 
         // Then reorder the element DOF values
         for (auto & elem : this->get_mesh().active_element_ptr_range())
           for (auto index : make_range(elem->n_comp(sys,var)))
             {
               libmesh_assert_not_equal_to (elem->dof_number(sys, var, index),
                                            DofObject::invalid_id);
 
               libmesh_assert_less (cnt, global_vector.size());
 
               reordered_vector[elem->dof_number(sys, var, index)] =
                 global_vector[cnt++];
             }
       }
 
     // use the overloaded operator=(std::vector) to assign the values
     vec = reordered_vector;
   };
 
   // 10.)
   // Read and set the solution vector
   if (this->processor_id() == 0)
     io.data (global_vector);
   reorder_vector_into(*(this->solution));
 
   // 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 = this->_vectors.begin();
 
       for (std::size_t i = 0; i != this->_additional_data_written; ++i)
         {
           // 11.)
           // Read the values of the vec-th additional vector.
           // Prior do _not_ clear, but fill with zero, since the
           // additional vectors _have_ to have the same size
           // as the solution vector
           std::fill (global_vector.begin(), global_vector.end(), libMesh::zero);
 
           if (this->processor_id() == 0)
             io.data (global_vector);
 
           // 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)
             {
               std::fill (reordered_vector.begin(),
                          reordered_vector.end(),
                          libMesh::zero);
 
               reorder_vector_into(*(pos->second));
             }
 
           // If we've got vectors then we need to be iterating through
           // those too
           if (pos != this->_vectors.end())
             ++pos;
         }
     } // end if (_additional_data_written)
 }

◆ read_parallel_data() [1/2]

template<typename InValType >

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

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 449 of file system_io.C.

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

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

◆ read_parallel_data() [2/2]

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

inline

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

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

◆ read_SCALAR_dofs()

unsigned int libMesh::System::read_SCALAR_dofs	(	const unsigned int	var,
		Xdr &	io,
		NumericVector< Number > *	vec
	)		const

private

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 1089 of file system_io.C.

References libMesh::ParallelObject::comm(), libMesh::Xdr::data_stream(), get_dof_map(), libMesh::OrderWrapper::get_order(), TIMPI::Communicator::get_unique_tag(), libMesh::index_range(), libMesh::ParallelObject::n_processors(), libMesh::FEType::order, libMesh::ParallelObject::processor_id(), TIMPI::Communicator::receive(), libMesh::DofMap::SCALAR_dof_indices(), TIMPI::Communicator::send(), libMesh::NumericVector< T >::set(), libMesh::Variable::type(), and variable().

Referenced by read_serialized_vector(), and read_serialized_vectors().

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

◆ 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

private

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 765 of file system_io.C.

References _written_var_indices, libMesh::ParallelObject::comm(), TIMPI::Communicator::get_unique_tag(), libMesh::MeshTools::Generation::Private::idx(), libMesh::index_range(), libMesh::invalid_uint, libMesh::Threads::NonConcurrentThread::join(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::ParallelObject::n_processors(), n_vars(), number(), libMesh::ParallelObject::processor_id(), TIMPI::Communicator::receive(), TIMPI::Communicator::send(), TIMPI::Status::source(), and TIMPI::Communicator::sum().

Referenced by read_serialized_vector(), and read_serialized_vectors().

 {
   //-------------------------------------------------------
   // 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.clear();
       vars_to_read.push_back(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;
 }

◆ read_serialized_data() [1/2]

template<typename InValType >

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

Reads additional data, namely vectors, for this System.

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

Definition at line 680 of file system_io.C.

References _additional_data_written, _vectors, libMesh::ParallelObject::processor_id(), and solution.

Referenced by libMesh::TransientRBConstruction::initialize_truth(), libMesh::TransientRBConstruction::read_riesz_representors_from_files(), and libMesh::RBConstruction::read_riesz_representors_from_files().

 {
   // This method implements the input of the vectors
   // contained in this System object, embedded in the
   // output of an EquationSystems<T_sys>.
   //
   //   10.) The global solution vector, re-ordered to be node-major
   //       (More on this later.)
   //
   //      for each additional vector in the object
   //
   //      11.) The global additional vector, re-ordered to be
   //          node-major (More on this later.)
   parallel_object_only();
   std::string comment;
 
   // PerfLog pl("IO Performance",false);
   // pl.push("read_serialized_data");
   // std::size_t total_read_size = 0;
 
   // 10.)
   // Read the global solution vector
   {
     // total_read_size +=
     this->read_serialized_vector<InValType>(io, this->solution.get());
 
     // get the comment
     if (this->processor_id() == 0)
       io.comment (comment);
   }
 
   // 11.)
   // Only read additional vectors if data is available, and only use
   // that data to fill our vectors if the user requested it.
   if (this->_additional_data_written)
     {
       const std::size_t nvecs = this->_vectors.size();
 
       // If the number of additional vectors written is non-zero, and
       // the number of additional vectors we have is non-zero, and
       // they don't match, then we can't read additional vectors
       // and be sure we're reading data into the correct places.
       if (read_additional_data && nvecs &&
           nvecs != this->_additional_data_written)
         libmesh_error_msg
           ("Additional vectors in file do not match system");
 
       auto pos = _vectors.begin();
 
       for (std::size_t i = 0; i != this->_additional_data_written; ++i)
         {
           // Read data, but only put it into a vector if we've been
           // asked to and if we have a corresponding vector to read.
 
           // total_read_size +=
           this->read_serialized_vector<InValType>
             (io, (read_additional_data && nvecs) ? pos->second.get() : nullptr);
 
           // get the comment
           if (this->processor_id() == 0)
             io.comment (comment);
 
 
           // If we've got vectors then we need to be iterating through
           // those too
           if (pos != this->_vectors.end())
             ++pos;
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_read_size*sizeof(Number)/dt;
 
   // libMesh::out << "Read " << total_read_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("read_serialized_data");
 }

◆ read_serialized_data() [2/2]

template LIBMESH_EXPORT void libMesh::System::read_serialized_data< Real >	(	Xdr &	io,
		const bool	read_additional_data = `true`
	)

inline

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

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

◆ read_serialized_vector() [1/2]

template<typename InValType >

numeric_index_type libMesh::System::read_serialized_vector	(	Xdr &	io,
		NumericVector< Number > *	vec
	)

private

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 1136 of file system_io.C.

References _written_var_indices, TIMPI::Communicator::broadcast(), libMesh::NumericVector< T >::close(), libMesh::ParallelObject::comm(), libMesh::Xdr::data(), get_mesh(), libMesh::GHOSTED, libMesh::libmesh_assert(), libMesh::MeshTools::n_elem(), libMesh::MeshBase::n_elem(), n_nodes, libMesh::MeshBase::n_nodes(), libMesh::ParallelObject::n_processors(), n_vars(), libMesh::PARALLEL, libMesh::ParallelObject::processor_id(), read_SCALAR_dofs(), read_serialized_blocked_dof_objects(), libMesh::Xdr::reading(), libMesh::SCALAR, TIMPI::Communicator::sum(), libMesh::NumericVector< T >::type(), variable(), and libMesh::Xdr::version().

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

◆ read_serialized_vector() [2/2]

numeric_index_type libMesh::System::read_serialized_vector	(	Xdr &	io,
		NumericVector< Number > &	vec
	)

inlineprivate

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

2016 { return read_serialized_vector<Number>(io, &vec); }

◆ 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

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 2165 of file system_io.C.

References libMesh::Xdr::data(), get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshTools::n_elem(), libMesh::MeshBase::n_elem(), n_nodes, libMesh::MeshBase::n_nodes(), n_vars(), libMesh::ParallelObject::processor_id(), read_SCALAR_dofs(), read_serialized_blocked_dof_objects(), libMesh::Xdr::reading(), libMesh::SCALAR, and variable().

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

 {
   parallel_object_only();
 
   // Error checking
   // #ifndef NDEBUG
   //   // In parallel we better be reading a parallel vector -- if not
   //   // we will not set all of its components below!!
   //   if (this->n_processors() > 1)
   //     {
   //       libmesh_assert (vec.type() == PARALLEL ||
   //       vec.type() == GHOSTED);
   //     }
   // #endif
 
   libmesh_assert (io.reading());
 
   if (this->processor_id() == 0)
     {
       // sizes
       unsigned int num_vecs=0;
       dof_id_type vector_length=0;
 
       // Get the number of vectors
       io.data(num_vecs);
       // Get the buffer size
       io.data(vector_length);
 
       libmesh_error_msg_if (num_vecs != vectors.size(), "Unexpected value of num_vecs");
 
       if (num_vecs != 0)
         {
           libmesh_error_msg_if (vectors[0] == nullptr, "vectors[0] should not be null");
           libmesh_error_msg_if (vectors[0]->size() != vector_length, "Inconsistent vector sizes");
         }
     }
 
   // no need to actually communicate these.
   // this->comm().broadcast(num_vecs);
   // this->comm().broadcast(vector_length);
 
   // Cache these - they are not free!
   const dof_id_type
     n_nodes = this->get_mesh().n_nodes(),
     n_elem  = this->get_mesh().n_elem();
 
   std::size_t read_length = 0;
 
   //---------------------------------
   // Collect the values for all nodes
   read_length +=
     this->read_serialized_blocked_dof_objects (n_nodes,
                                                this->get_mesh().local_nodes_begin(),
                                                this->get_mesh().local_nodes_end(),
                                                InValType(),
                                                io,
                                                vectors);
 
   //------------------------------------
   // Collect the values for all elements
   read_length +=
     this->read_serialized_blocked_dof_objects (n_elem,
                                                this->get_mesh().local_elements_begin(),
                                                this->get_mesh().local_elements_end(),
                                                InValType(),
                                                io,
                                                vectors);
 
   //-------------------------------------------
   // Finally loop over all the SCALAR variables
   for (NumericVector<Number> * vec : vectors)
     for (auto var : make_range(this->n_vars()))
       if (this->variable(var).type().family == SCALAR)
         {
           libmesh_assert_not_equal_to (vec, 0);
 
           read_length +=
             this->read_SCALAR_dofs (var, io, vec);
         }
 
   //---------------------------------------
   // last step - must close all the vectors
   for (NumericVector<Number> * vec : vectors)
     {
       libmesh_assert_not_equal_to (vec, 0);
       vec->close();
     }
 
   return read_length;
 }

◆ read_serialized_vectors() [2/2]

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

inline

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

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

◆ reinit()

void libMesh::System::reinit ( )

virtual

Reinitializes degrees of freedom and other required data on the current mesh.

Note: The matrix is not initialized at this time since it may not be required for all applications. Should be overridden in derived classes.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::LinearImplicitSystem, libMesh::EigenSystem, libMesh::DifferentiableSystem, and libMesh::NewmarkSystem.

Definition at line 446 of file system.C.

References _basic_system_only, _matrices, libMesh::DofMap::clear_sparsity(), libMesh::DofMap::compute_sparsity(), current_local_solution, get_dof_map(), get_mesh(), and solution.

Referenced by alternative_fe_assembly(), libMesh::RBEIMConstruction::initialize_qp_data(), libMesh::DifferentiableSystem::reinit(), libMesh::EigenSystem::reinit(), libMesh::LinearImplicitSystem::reinit(), libMesh::OptimizationSystem::reinit(), and libMesh::NonlinearImplicitSystem::reinit().

 {
   parallel_object_only();
 
   // project_vector handles vector initialization now
   libmesh_assert_equal_to (solution->size(), current_local_solution->size());
 
   if (!_matrices.empty() && !_basic_system_only)
     {
       // Clear the matrices
       for (auto & pr : _matrices)
         {
           pr.second->clear();
           pr.second->attach_dof_map(this->get_dof_map());
         }
 
       // Clear the sparsity pattern
       this->get_dof_map().clear_sparsity();
 
       // Compute the sparsity pattern for the current
       // mesh and DOF distribution.  This also updates
       // additional matrices, \p DofMap now knows them
       this->get_dof_map().compute_sparsity (this->get_mesh());
 
       // Initialize matrices and set to zero
       for (auto & pr : _matrices)
         {
           pr.second->init();
           pr.second->zero();
         }
     }
 }

◆ reinit_constraints()

void libMesh::System::reinit_constraints ( )

virtual

Reinitializes the constraints for this system.

Definition at line 480 of file system.C.

References _mesh, libMesh::DofMap::create_dof_constraints(), get_dof_map(), libMesh::DofMap::prepare_send_list(), libMesh::DofMap::process_constraints(), time, and user_constrain().

Referenced by libMesh::EquationSystems::allgather(), libMesh::PetscDMWrapper::init_and_attach_petscdm(), init_data(), and libMesh::EquationSystems::reinit_solutions().

 {
   parallel_object_only();
 
 #ifdef LIBMESH_ENABLE_CONSTRAINTS
   get_dof_map().create_dof_constraints(_mesh, this->time);
   user_constrain();
   get_dof_map().process_constraints(_mesh);
 #endif
   get_dof_map().prepare_send_list();
 }

◆ reinit_mesh()

void libMesh::System::reinit_mesh ( )

virtual

Reinitializes the system with a new mesh.

Definition at line 304 of file system.C.

References _basic_system_only, init_data(), n_vars(), and user_initialization().

 {
   parallel_object_only();
 
   // First initialize any required data:
   // either only the basic System data
   if (_basic_system_only)
     System::init_data();
   // or all the derived class' data too
   else
     this->init_data();
 
   // If no variables have been added to this system
   // don't do anything
   if (!this->n_vars())
     return;
 
   // Then call the user-provided initialization function
   this->user_initialization();
 
 }

◆ remove_matrix()

void libMesh::System::remove_matrix ( std::string_view mat_name )

Removes the additional matrix mat_name from this system.

Definition at line 1032 of file system.C.

References _matrices.

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   matrices_iterator pos = _matrices.find(mat_name);
 
   // Return if the matrix does not exist
   if (pos == _matrices.end())
     return;
 
   _matrices.erase(pos); // erase()'d entries are destroyed
 }

◆ remove_vector()

void libMesh::System::remove_vector ( std::string_view vec_name )

Removes the additional vector vec_name from this system.

Definition at line 846 of file system.C.

References _vector_is_adjoint, _vector_projections, _vectors, and libMesh::libmesh_assert().

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and libMesh::UnsteadySolver::integrate_adjoint_sensitivity().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   vectors_iterator pos = _vectors.find(vec_name);
 
   //Return if the vector does not exist
   if (pos == _vectors.end())
     return;
 
   _vectors.erase(pos);
   auto proj_it = _vector_projections.find(vec_name);
   libmesh_assert(proj_it != _vector_projections.end());
   _vector_projections.erase(proj_it);
 
   auto adj_it = _vector_is_adjoint.find(vec_name);
   libmesh_assert(adj_it != _vector_is_adjoint.end());
   _vector_is_adjoint.erase(adj_it);
 }

◆ request_matrix() [1/2]

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

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

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

 {
   // Make sure the matrix exists
   const_matrices_iterator pos = _matrices.find(mat_name);
 
   if (pos == _matrices.end())
     return nullptr;
 
   return pos->second.get();
 }

◆ request_matrix() [2/2]

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

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

References _matrices.

 {
   // Make sure the matrix exists
   matrices_iterator pos = _matrices.find(mat_name);
 
   if (pos == _matrices.end())
     return nullptr;
 
   return pos->second.get();
 }

◆ request_vector() [1/4]

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

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

Definition at line 866 of file system.C.

References _vectors.

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

 {
   const_vectors_iterator pos = _vectors.find(vec_name);
 
   if (pos == _vectors.end())
     return nullptr;
 
   return pos->second.get();
 }

◆ request_vector() [2/4]

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

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

Definition at line 878 of file system.C.

References _vectors.

 {
   vectors_iterator pos = _vectors.find(vec_name);
 
   if (pos == _vectors.end())
     return nullptr;
 
   return pos->second.get();
 }

◆ request_vector() [3/4]

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

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

References _vectors, and vectors_begin().

 {
   // If we don't have that many vectors, return nullptr
   if (vec_num >= _vectors.size())
     return nullptr;
 
   // Otherwise return a pointer to the vec_num'th vector
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return it->second.get();
 }

◆ request_vector() [4/4]

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

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

References _vectors, and vectors_begin().

 {
   // If we don't have that many vectors, return nullptr
   if (vec_num >= _vectors.size())
     return nullptr;
 
   // Otherwise return a pointer to the vec_num'th vector
   auto it = vectors_begin();
   std::advance(it, vec_num);
   return it->second.get();
 }

◆ restrict_solve_to()

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

virtual

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

 {
   if (subset != nullptr)
     libmesh_not_implemented();
 }

◆ restrict_vectors()

void libMesh::System::restrict_vectors ( )

virtual

Restrict vectors after the mesh has coarsened.

Definition at line 378 of file system.C.

References _dof_map, _solution_projection, _vector_projections, _vectors, current_local_solution, libMesh::NumericVector< T >::get(), libMesh::GHOSTED, n_dofs(), n_local_dofs(), libMesh::PARALLEL, project_vector(), solution, and vector_is_adjoint().

Referenced by prolong_vectors(), and libMesh::EquationSystems::reinit_solutions().

 {
   parallel_object_only();
 
 #ifdef LIBMESH_ENABLE_AMR
   // Restrict the _vectors on the coarsened cells
   for (auto & [vec_name, vec] : _vectors)
     {
       NumericVector<Number> * v = vec.get();
 
       if (_vector_projections[vec_name])
         {
           this->project_vector (*v, this->vector_is_adjoint(vec_name));
         }
       else
         {
           const ParallelType type = vec->type();
 
           if (type == GHOSTED)
             {
 #ifdef LIBMESH_ENABLE_GHOSTED
               vec->init (this->n_dofs(), this->n_local_dofs(),
                                _dof_map->get_send_list(), /*fast=*/false,
                                GHOSTED);
 #else
               libmesh_error_msg("Cannot initialize ghosted vectors when they are not enabled.");
 #endif
             }
           else
             vec->init (this->n_dofs(), this->n_local_dofs(), false, type);
         }
     }
 
   const std::vector<dof_id_type> & send_list = _dof_map->get_send_list ();
 
   // Restrict the solution on the coarsened cells
   if (_solution_projection)
     this->project_vector (*solution);
   // Or at least make sure the solution vector is the correct size
   else
     solution->init (this->n_dofs(), this->n_local_dofs(), true, PARALLEL);
 
 #ifdef LIBMESH_ENABLE_GHOSTED
   current_local_solution->init(this->n_dofs(),
                                this->n_local_dofs(), send_list,
                                false, GHOSTED);
 #else
   current_local_solution->init(this->n_dofs());
 #endif
 
   if (_solution_projection)
     solution->localize (*current_local_solution, send_list);
 
 #endif // LIBMESH_ENABLE_AMR
 }

◆ sensitivity_solve()

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

inlinevirtual

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

 {
   libmesh_not_implemented();
 }

◆ set_adjoint_already_solved()

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

inline

Setter for the adjoint_already_solved boolean.

Definition at line 412 of file system.h.

References adjoint_already_solved.

Referenced by main().

413 { adjoint_already_solved = setting;}

libMesh::System::adjoint_already_solved

bool adjoint_already_solved

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

Definition: system.h:2242

◆ set_basic_system_only()

void libMesh::System::set_basic_system_only ( )

inline

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

References _basic_system_only.

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

 {
   _basic_system_only = true;
 }

◆ set_project_with_constraints()

void libMesh::System::set_project_with_constraints ( bool _project_with_constraints )

inline

Definition at line 1780 of file system.h.

References project_with_constraints.

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

   {
     project_with_constraints = _project_with_constraints;
   }

◆ set_qoi() [1/2]

void libMesh::System::set_qoi	(	unsigned int	qoi_index,
		Number	qoi_value
	)

Definition at line 2326 of file system.C.

References libMesh::libmesh_assert(), and qoi.

Referenced by libMesh::ExplicitSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), and libMesh::EulerSolver::integrate_qoi_timestep().

 {
   libmesh_assert(qoi_index < qoi.size());
 
   qoi[qoi_index] = qoi_value;
 }

◆ set_qoi() [2/2]

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

Definition at line 2347 of file system.C.

References qoi.

 {
   libmesh_assert_equal_to(this->qoi.size(), new_qoi.size());
   this->qoi = std::move(new_qoi);
 }

◆ set_qoi_error_estimate()

void libMesh::System::set_qoi_error_estimate	(	unsigned int	qoi_index,
		Number	qoi_error_estimate
	)

Definition at line 2354 of file system.C.

References libMesh::libmesh_assert(), and qoi_error_estimates.

Referenced by libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), and libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate().

 {
   libmesh_assert(qoi_index < qoi_error_estimates.size());
 
   qoi_error_estimates[qoi_index] = qoi_error_estimate;
 }

◆ set_vector_as_adjoint()

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

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

References _vector_is_adjoint.

Referenced by add_adjoint_solution(), and add_weighted_sensitivity_adjoint_solution().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   // We reserve -1 for vectors which get primal constraints, -2 for
   // vectors which get no constraints
   libmesh_assert_greater_equal(qoi_num, -2);
   _vector_is_adjoint[vec_name] = qoi_num;
 }

◆ set_vector_preservation()

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

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

References _vector_projections.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and main().

 {
   parallel_object_only();  // Not strictly needed, but the only safe way to keep in sync
 
   _vector_projections[vec_name] = preserve;
 }

◆ solve()

virtual void libMesh::System::solve ( )

inlinevirtual

Solves the system.

Should be overridden in derived systems.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::ImplicitSystem, libMesh::DifferentiableSystem, libMesh::LinearImplicitSystem, libMesh::ExplicitSystem, libMesh::FEMSystem, libMesh::CondensedEigenSystem, libMesh::FrequencySystem, libMesh::EigenSystem, and libMesh::ContinuationSystem.

Definition at line 344 of file system.h.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), main(), and SystemsTest::testAssemblyWithDgFemContext().

344 {}

◆ solve_for_unconstrained_dofs()

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

protected

Definition at line 2041 of file system_projection.C.

References libMesh::DofMap::build_sparsity(), libMesh::DofMap::computed_sparsity_already(), libMesh::DofMap::end_dof(), libMesh::DofMap::first_dof(), libMesh::NumericVector< T >::get(), libMesh::DofMap::heterogenously_constrain_element_matrix_and_vector(), libMesh::DofMap::is_constrained_dof(), libMesh::NumericVector< T >::local_size(), libMesh::DofMap::n_dofs(), libMesh::DofMap::n_local_dofs(), libMesh::PARALLEL, libMesh::Real, libMesh::NumericVector< T >::size(), and libMesh::DofMap::update_sparsity_pattern().

 {
   const DofMap & dof_map = this->get_dof_map();
 
   std::unique_ptr<SparseMatrix<Number>> mat =
     SparseMatrix<Number>::build(this->comm());
 
   std::unique_ptr<SparsityPattern::Build> sp;
 
   if (dof_map.computed_sparsity_already())
     dof_map.update_sparsity_pattern(*mat);
   else
     {
       mat->attach_dof_map(dof_map);
       sp = dof_map.build_sparsity(this->get_mesh());
       mat->attach_sparsity_pattern(*sp);
     }
 
   mat->init();
 
   libmesh_assert_equal_to(vec.size(), dof_map.n_dofs());
   libmesh_assert_equal_to(vec.local_size(), dof_map.n_local_dofs());
 
   std::unique_ptr<NumericVector<Number>> rhs =
     NumericVector<Number>::build(this->comm());
 
   rhs->init(dof_map.n_dofs(), dof_map.n_local_dofs(), false,
             PARALLEL);
 
   // Here we start with the unconstrained (and indeterminate) linear
   // system, K*u = f, where K is the identity matrix for constrained
   // DoFs and 0 elsewhere, and f is the current solution values for
   // constrained DoFs and 0 elsewhere.
   // We then apply the usual heterogeneous constraint matrix C and
   // offset h, where u = C*x + h,
   // to get C^T*K*C*x = C^T*f - C^T*K*h
   // - a constrained and no-longer-singular system that finds the
   // closest approximation for the unconstrained degrees of freedom.
   //
   // Here, though "closest" is in an algebraic sense; we're
   // effectively using a pseudoinverse that optimizes in a
   // discretization-dependent norm.  That only seems to give ~0.1%
   // excess error even in coarse unit test cases, but at some point it
   // might be reasonable to weight K and f properly.
 
   for (dof_id_type d : IntRange<dof_id_type>(dof_map.first_dof(),
                                              dof_map.end_dof()))
     {
       if (dof_map.is_constrained_dof(d))
         {
           DenseMatrix<Number> K(1,1);
           DenseVector<Number> F(1);
           std::vector<dof_id_type> dof_indices(1, d);
           K(0,0) = 1;
           F(0) = (*this->solution)(d);
           dof_map.heterogenously_constrain_element_matrix_and_vector
             (K, F, dof_indices, false, is_adjoint);
           mat->add_matrix(K, dof_indices);
           rhs->add_vector(F, dof_indices);
         }
     }
 
   std::unique_ptr<LinearSolver<Number>> linear_solver =
     LinearSolver<Number>::build(this->comm());
 
   linear_solver->solve(*mat, vec, *rhs,
                        double(this->get_equation_systems().parameters.get<Real>("linear solver tolerance")),
                        this->get_equation_systems().parameters.get<unsigned int>("linear solver maximum iterations"));
 }

◆ system()

sys_type& libMesh::System::system ( )

inline

Returns: A reference to *this.

Definition at line 253 of file system.h.

253 { return *this; }

◆ system_type()

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

inlinevirtual

Returns: The type of system, helpful in identifying which system type to use when reading equation system data from file. Should be overridden in derived classes.

Reimplemented in libMesh::NonlinearImplicitSystem, libMesh::OptimizationSystem, libMesh::LinearImplicitSystem, libMesh::RBConstruction, libMesh::EigenSystem, libMesh::FrequencySystem, libMesh::ExplicitSystem, libMesh::ImplicitSystem, libMesh::TransientSystem< RBConstruction >, libMesh::NewmarkSystem, and SolidSystem.

Definition at line 505 of file system.h.

Referenced by get_info().

505 { return "Basic"; }

◆ update()

void libMesh::System::update ( )

virtual

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

Reimplemented in SolidSystem.

Definition at line 493 of file system.C.

References _dof_map, current_local_solution, libMesh::libmesh_assert(), and solution.

Referenced by libMesh::__libmesh_petsc_diff_solver_jacobian(), libMesh::__libmesh_petsc_diff_solver_residual(), libMesh::UniformRefinementEstimator::_estimate_error(), HDGProblem::assemble(), libMesh::FEMSystem::assemble_qoi(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::NonlinearImplicitSystem::assembly(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::NewmarkSolver::compute_initial_accel(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), libMesh::Problem_Interface::computeF(), libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), libMesh::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::libmesh_petsc_snes_fd_residual(), libMesh::libmesh_petsc_snes_jacobian(), libMesh::libmesh_petsc_snes_mffd_residual(), libMesh::libmesh_petsc_snes_residual(), libMesh::libmesh_petsc_snes_residual_helper(), libMesh::NewtonSolver::line_search(), libMesh::RBConstruction::load_basis_function(), libMesh::TransientRBConstruction::load_rb_solution(), libMesh::RBConstruction::load_rb_solution(), main(), libMesh::FEMSystem::mesh_position_get(), HeatSystem::perturb_accumulate_residuals(), libMesh::FEMSystem::postprocess(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::MemorySolutionHistory::retrieve(), libMesh::FileSolutionHistory::retrieve(), libMesh::NewtonSolver::solve(), libMesh::ExplicitSystem::solve(), libMesh::LinearImplicitSystem::solve(), libMesh::OptimizationSystem::solve(), libMesh::NonlinearImplicitSystem::solve(), libMesh::RBConstruction::solve_for_matrix_and_rhs(), libMesh::MeshFunctionSolutionTransfer::transfer(), and libMesh::DirectSolutionTransfer::transfer().

 {
   parallel_object_only();
 
   libmesh_assert(solution->closed());
 
   const std::vector<dof_id_type> & send_list = _dof_map->get_send_list ();
 
   // Check sizes
   libmesh_assert_equal_to (current_local_solution->size(), solution->size());
   // More processors than elements => empty send_list
   //  libmesh_assert (!send_list.empty());
   libmesh_assert_less_equal (send_list.size(), solution->size());
 
   // Create current_local_solution from solution.  This will
   // put a local copy of solution into current_local_solution.
   // Only the necessary values (specified by the send_list)
   // are copied to minimize communication
   solution->localize (*current_local_solution, send_list);
 }

◆ update_global_solution() [1/2]

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

Requires communication with all other processors.

Definition at line 728 of file system.C.

References solution.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::ExactErrorEstimator::estimate_error(), main(), and libMesh::InterMeshProjection::project_system_vectors().

 {
   parallel_object_only();
 
   global_soln.resize (solution->size());
 
   solution->localize (global_soln);
 }

◆ update_global_solution() [2/2]

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

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

References solution.

 {
   parallel_object_only();
 
   global_soln.resize        (solution->size());
 
   solution->localize_to_one (global_soln, dest_proc);
 }

◆ user_assembly()

void libMesh::System::user_assembly ( )

virtual

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

Definition at line 2259 of file system.C.

References _assemble_system_function, _assemble_system_object, _equation_systems, libMesh::System::Assembly::assemble(), and name().

Referenced by assemble().

 {
   // Call the user-provided assembly function,
   // if it was provided
   if (_assemble_system_function != nullptr)
     this->_assemble_system_function (_equation_systems, this->name());
 
   // ...or the user-provided assembly object.
   else if (_assemble_system_object != nullptr)
     this->_assemble_system_object->assemble();
 }

◆ user_constrain()

void libMesh::System::user_constrain ( )

virtual

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

Definition at line 2273 of file system.C.

References _constrain_system_function, _constrain_system_object, _equation_systems, libMesh::System::Constraint::constrain(), and name().

Referenced by reinit_constraints().

 {
   // Call the user-provided constraint function,
   // if it was provided
   if (_constrain_system_function!= nullptr)
     this->_constrain_system_function(_equation_systems, this->name());
 
   // ...or the user-provided constraint object.
   else if (_constrain_system_object != nullptr)
     this->_constrain_system_object->constrain();
 }

◆ user_initialization()

void libMesh::System::user_initialization ( )

virtual

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

Definition at line 2245 of file system.C.

References _equation_systems, _init_system_function, _init_system_object, libMesh::System::Initialization::initialize(), and name().

Referenced by init(), libMesh::NewmarkSystem::initial_conditions(), and reinit_mesh().

 {
   // Call the user-provided initialization function,
   // if it was provided
   if (_init_system_function != nullptr)
     this->_init_system_function (_equation_systems, this->name());
 
   // ...or the user-provided initialization object.
   else if (_init_system_object != nullptr)
     this->_init_system_object->initialize();
 }

◆ user_QOI()

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

virtual

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

Definition at line 2287 of file system.C.

References _equation_systems, _qoi_evaluate_function, _qoi_evaluate_object, name(), and libMesh::System::QOI::qoi().

Referenced by assemble_qoi().

 {
   // Call the user-provided quantity of interest function,
   // if it was provided
   if (_qoi_evaluate_function != nullptr)
     this->_qoi_evaluate_function(_equation_systems, this->name(), qoi_indices);
 
   // ...or the user-provided QOI function object.
   else if (_qoi_evaluate_object != nullptr)
     this->_qoi_evaluate_object->qoi(qoi_indices);
 }

◆ user_QOI_derivative()

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

virtual

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

Definition at line 2301 of file system.C.

References _equation_systems, _qoi_evaluate_derivative_function, _qoi_evaluate_derivative_object, name(), and libMesh::System::QOIDerivative::qoi_derivative().

Referenced by assemble_qoi_derivative().

 {
   // Call the user-provided quantity of interest derivative,
   // if it was provided
   if (_qoi_evaluate_derivative_function != nullptr)
     this->_qoi_evaluate_derivative_function
       (_equation_systems, this->name(), qoi_indices, include_liftfunc,
        apply_constraints);
 
   // ...or the user-provided QOI derivative function object.
   else if (_qoi_evaluate_derivative_object != nullptr)
     this->_qoi_evaluate_derivative_object->qoi_derivative
       (qoi_indices, include_liftfunc, apply_constraints);
 }

◆ variable()

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

inline

Return a constant reference to Variable var.

Definition at line 2377 of file system.h.

References _variables.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::PetscDMWrapper::add_dofs_to_section(), libMesh::DifferentiableSystem::add_second_order_dot_vars(), add_variable(), 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(), libMesh::DifferentiablePhysics::nonlocal_mass_residual(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), point_gradient(), point_hessian(), point_value(), read_parallel_data(), read_SCALAR_dofs(), read_serialized_vector(), read_serialized_vectors(), libMesh::PetscDMWrapper::set_point_range_in_section(), write_header(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), write_parallel_data(), write_serialized_vector(), and write_serialized_vectors().

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

◆ variable_group()

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

inline

Return a constant reference to VariableGroup vg.

Definition at line 2387 of file system.h.

References _variable_groups.

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

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

◆ variable_name()

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

inline

Returns: The name of variable i.

Definition at line 2397 of file system.h.

References _variables.

Referenced by add_variable(), add_variables(), libMesh::PetscDMWrapper::build_section(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::ExactSolution::ExactSolution(), libMesh::EquationSystems::find_variable_numbers(), main(), output_norms(), libMesh::petsc_auto_fieldsplit(), libMesh::InterMeshProjection::project_system_vectors(), MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData(), write_header(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

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

◆ variable_number()

unsigned int libMesh::System::variable_number ( std::string_view var ) const

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

Definition at line 1557 of file system.C.

References _variable_numbers, _variables, and name().

Referenced by libMesh::ExactSolution::_compute_error(), alternative_fe_assembly(), LinearElasticity::assemble(), HDGProblem::assemble(), AssembleOptimization::assemble_A_and_F(), assemble_divgrad(), assemble_elasticity(), assemble_matrix_and_rhs(), assemble_shell(), assemble_stokes(), compute_enriched_soln(), compute_stresses(), LinearElasticityWithContact::compute_stresses(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::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(), CoupledSystemQoI::init_context(), LargeDeformationElasticity::jacobian(), line_print(), main(), LinearElasticityWithContact::move_mesh(), read_header(), LargeDeformationElasticity::residual(), LinearElasticityWithContact::residual_and_jacobian(), OverlappingAlgebraicGhostingTest::run_ghosting_test(), OverlappingCouplingGhostingTest::run_sparsity_pattern_test(), OverlappingTestBase::setup_coupling_matrix(), libMesh::DTKAdapter::update_variable_values(), variable_scalar_number(), variable_type(), libMesh::EnsightIO::write_scalar_ascii(), and libMesh::EnsightIO::write_vector_ascii().

 {
   auto var_num = libmesh_map_find(_variable_numbers, var);
   libmesh_assert_equal_to (_variables[var_num].name(), var);
   return var_num;
 }

◆ variable_scalar_number() [1/2]

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

inline

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

References variable_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 >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), and libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()().

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

◆ variable_scalar_number() [2/2]

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

inline

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

References _variables.

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

◆ variable_type() [1/2]

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

inline

Returns: The finite element type variable number i.

Definition at line 2427 of file system.h.

References _variables.

Referenced by libMesh::ExactSolution::_compute_error(), add_variable(), add_variables(), alternative_fe_assembly(), assemble(), assemble_ellipticdg(), assemble_shell(), assemble_stokes(), libMesh::FEMContext::attach_quadrature_rules(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::Nemesis_IO::copy_elemental_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::DGFEMContext::DGFEMContext(), fe_assembly(), libMesh::FEMContext::find_hardest_fe_type(), libMesh::EquationSystems::find_variable_numbers(), libMesh::FEMSystem::init_context(), libMesh::FEMContext::init_internal_data(), RationalMapTest< elem_type >::setUp(), FETestBase< order, family, elem_type, 1 >::setUp(), EquationSystemsTest::testBadVarNames(), libMesh::Nemesis_IO_Helper::write_element_values(), write_header(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), libMesh::EnsightIO::write_scalar_ascii(), and libMesh::EnsightIO::write_vector_ascii().

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

◆ variable_type() [2/2]

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

inline

Returns: The finite element type for variable var.

Definition at line 2437 of file system.h.

References _variables, and variable_number().

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

◆ vector_is_adjoint()

int libMesh::System::vector_is_adjoint ( std::string_view vec_name ) const

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

References _vector_is_adjoint, and libMesh::libmesh_assert().

Referenced by libMesh::InterMeshProjection::project_system_vectors(), and restrict_vectors().

 {
   libmesh_assert(_vector_is_adjoint.find(vec_name) !=
                  _vector_is_adjoint.end());
 
   return _vector_is_adjoint.find(vec_name)->second;
 }

◆ vector_name() [1/2]

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

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

Definition at line 958 of file system.C.

References _vectors, and vectors_begin().

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), and main().

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

◆ vector_name() [2/2]

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

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

Definition at line 969 of file system.C.

References _vectors, libMesh::NumericVector< T >::get(), libMesh::libmesh_assert(), vectors_begin(), and vectors_end().

 {
   // Linear search for a vector whose pointer matches vec_reference
   auto it = std::find_if(vectors_begin(), vectors_end(),
                          [&vec_reference](const decltype(_vectors)::value_type & pr)
                          { return &vec_reference == pr.second.get(); });
 
   // Before returning, make sure we didn't loop till the end and not find any match
   libmesh_assert (it != vectors_end());
 
   // Return the string associated with the current vector
   return it->first;
 }

◆ vector_preservation()

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

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

Definition at line 1097 of file system.C.

References _vector_projections.

Referenced by libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::MemoryHistoryData::store_vectors(), SystemsTest::testAddVectorProjChange(), SystemsTest::testAddVectorTypeChange(), and SystemsTest::testPostInitAddVectorTypeChange().

 {
   if (_vector_projections.find(vec_name) == _vector_projections.end())
     return false;
 
   return _vector_projections.find(vec_name)->second;
 }

◆ vectors_begin() [1/2]

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

inline

Beginning of vectors container.

Definition at line 2483 of file system.h.

References _vectors.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), get_vector(), libMesh::InterMeshProjection::project_system_vectors(), request_vector(), libMesh::MemoryHistoryData::store_vectors(), and vector_name().

 {
   return _vectors.begin();
 }

◆ vectors_begin() [2/2]

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

inline

Beginning of vectors container.

Definition at line 2489 of file system.h.

References _vectors.

 {
   return _vectors.begin();
 }

◆ vectors_end() [1/2]

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

inline

End of vectors container.

Definition at line 2495 of file system.h.

References _vectors.

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

 {
   return _vectors.end();
 }

◆ vectors_end() [2/2]

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

inline

End of vectors container.

Definition at line 2501 of file system.h.

References _vectors.

 {
   return _vectors.end();
 }

◆ weighted_sensitivity_adjoint_solve()

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

inlinevirtual

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

inlinevirtual

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

 {
   libmesh_not_implemented();
 }

◆ write_header()

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

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 1267 of file system_io.C.

References _vector_projections, _vectors, libMesh::Variable::active_subdomains(), libMesh::Xdr::data(), libMesh::FEType::family, get_mesh(), libMesh::FEType::inf_map, libMesh::libmesh_assert(), libMesh::make_range(), n_vars(), n_vectors(), name(), libMesh::FEType::order, libMesh::ParallelObject::processor_id(), libMesh::FEType::radial_family, libMesh::FEType::radial_order, variable(), variable_name(), variable_type(), and libMesh::Xdr::writing().

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

 {
   libmesh_assert (io.writing());
 
 
   // Only write the header information
   // if we are processor 0.
   if (this->get_mesh().processor_id() != 0)
     return;
 
   std::string comment;
 
   // 5.)
   // Write the number of variables in the system
 
   {
     // set up the comment
     comment = "# No. of Variables in System \"";
     comment += this->name();
     comment += "\"";
 
     unsigned int nv = this->n_vars();
     io.data (nv, comment);
   }
 
 
   for (auto var : make_range(this->n_vars()))
     {
       // 6.)
       // Write the name of the var-th variable
       {
         // set up the comment
         comment  = "#   Name, Variable No. ";
         comment += std::to_string(var);
         comment += ", System \"";
         comment += this->name();
         comment += "\"";
 
         std::string var_name = this->variable_name(var);
         io.data (var_name, comment);
       }
 
       // 6.1.) Variable subdomains
       {
         // set up the comment
         comment  = "#     Subdomains, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         const std::set<subdomain_id_type> & domains = this->variable(var).active_subdomains();
         std::vector<subdomain_id_type> domain_array;
         domain_array.assign(domains.begin(), domains.end());
         io.data (domain_array, comment);
       }
 
       // 7.)
       // Write the approximation order of the var-th variable
       // in this system
       {
         // set up the comment
         comment = "#     Approximation Order, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int order = static_cast<int>(this->variable_type(var).order);
         io.data (order, comment);
       }
 
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
 
       // do the same for radial_order
       {
         comment = "#     Radial Approximation Order, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int rad_order = static_cast<int>(this->variable_type(var).radial_order);
         io.data (rad_order, comment);
       }
 
 #endif
 
       // Write the Finite Element type of the var-th variable
       // in this System
       {
         // set up the comment
         comment = "#     FE Family, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         const FEType & type = this->variable_type(var);
         int fam = static_cast<int>(type.family);
         io.data (fam, comment);
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
 
         comment = "#     Radial FE Family, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int radial_fam = static_cast<int>(type.radial_family);
         io.data (radial_fam, comment);
 
         comment = "#     Infinite Mapping Type, Variable \"";
         comment += this->variable_name(var);
         comment += "\", System \"";
         comment += this->name();
         comment += "\"";
 
         int i_map = static_cast<int>(type.inf_map);
         io.data (i_map, comment);
 #endif
       }
     } // end of the variable loop
 
   // 8.)
   // Write the number of additional vectors in the System.
   // If write_additional_data==false, then write zero for
   // the number of additional vectors.
   {
     {
       // set up the comment
       comment = "# No. of Additional Vectors, System \"";
       comment += this->name();
       comment += "\"";
 
       unsigned int nvecs = write_additional_data ? this->n_vectors () : 0;
       io.data (nvecs, comment);
     }
 
     if (write_additional_data)
       {
         unsigned int cnt=0;
         for (const auto & [vec_name, vec] : _vectors)
           {
             // 9.)
             // write the name of the cnt-th additional vector
             const std::string dth_vector = std::to_string(cnt++)+"th vector";
             comment =  "# Name of " + dth_vector;
             std::string nonconst_vec_name = vec_name; // Stupid XDR API
 
             io.data (nonconst_vec_name, comment);
             int vec_projection = _vector_projections.at(vec_name);
             comment = "# Whether to do projections for " + dth_vector;
             io.data (vec_projection, comment);
             int vec_type = vec->type();
             comment = "# Parallel type of " + dth_vector;
             io.data (vec_type, comment);
           }
       }
   }
 }

◆ write_parallel_data()

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

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 1468 of file system_io.C.

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

 {
   // PerfLog pl("IO Performance",false);
   // pl.push("write_parallel_data");
   // std::size_t total_written_size = 0;
 
   std::string comment;
 
   libmesh_assert (io.writing());
 
   std::vector<Number> io_buffer; io_buffer.reserve(this->solution->local_size());
 
   // build the ordered nodes and element maps.
   // when writing/reading parallel files we need to iterate
   // over our nodes/elements in order of increasing global id().
   // however, this is not guaranteed to be ordering we obtain
   // by using the node_iterators/element_iterators directly.
   // so build a set, sorted by id(), that provides the ordering.
   // further, for memory economy build the set but then transfer
   // its contents to vectors, which will be sorted.
   std::vector<const DofObject *> ordered_nodes, ordered_elements;
   {
     std::set<const DofObject *, CompareDofObjectsByID>
       ordered_nodes_set (this->get_mesh().local_nodes_begin(),
                          this->get_mesh().local_nodes_end());
 
     ordered_nodes.insert(ordered_nodes.end(),
                          ordered_nodes_set.begin(),
                          ordered_nodes_set.end());
   }
   {
     std::set<const DofObject *, CompareDofObjectsByID>
       ordered_elements_set (this->get_mesh().local_elements_begin(),
                             this->get_mesh().local_elements_end());
 
     ordered_elements.insert(ordered_elements.end(),
                             ordered_elements_set.begin(),
                             ordered_elements_set.end());
   }
 
   const unsigned int sys_num = this->number();
   const unsigned int nv      = this->n_vars();
 
   // Loop over each non-SCALAR variable and each node, and write out the value.
   for (unsigned int var=0; var<nv; var++)
     if (this->variable(var).type().family != SCALAR)
       {
         // First write the node DOF values
         for (const auto & node : ordered_nodes)
           for (auto comp : make_range(node->n_comp(sys_num,var)))
             {
               libmesh_assert_not_equal_to (node->dof_number(sys_num, var, comp),
                                            DofObject::invalid_id);
 
               io_buffer.push_back((*this->solution)(node->dof_number(sys_num, var, comp)));
             }
 
         // Then write the element DOF values
         for (const auto & elem : ordered_elements)
           for (auto comp : make_range(elem->n_comp(sys_num,var)))
             {
               libmesh_assert_not_equal_to (elem->dof_number(sys_num, var, comp),
                                            DofObject::invalid_id);
 
               io_buffer.push_back((*this->solution)(elem->dof_number(sys_num, var, comp)));
             }
       }
 
   // Finally, write the SCALAR data on the last processor
   for (auto var : make_range(this->n_vars()))
     if (this->variable(var).type().family == SCALAR)
       {
         if (this->processor_id() == (this->n_processors()-1))
           {
             const DofMap & dof_map = this->get_dof_map();
             std::vector<dof_id_type> SCALAR_dofs;
             dof_map.SCALAR_dof_indices(SCALAR_dofs, var);
 
             for (auto dof : SCALAR_dofs)
               io_buffer.push_back((*this->solution)(dof));
           }
       }
 
   // 9.)
   //
   // Actually write the reordered solution vector
   // for the ith system to disk
 
   // set up the comment
   {
     comment = "# System \"";
     comment += this->name();
     comment += "\" Solution Vector";
   }
 
   io.data (io_buffer, comment);
 
   // total_written_size += io_buffer.size();
 
   // Only write additional vectors if wanted
   if (write_additional_data)
     {
       for (auto & [vec_name, vec] : _vectors)
         {
           io_buffer.clear();
           io_buffer.reserve(vec->local_size());
 
           // Loop over each non-SCALAR variable and each node, and write out the value.
           for (unsigned int var=0; var<nv; var++)
             if (this->variable(var).type().family != SCALAR)
               {
                 // First write the node DOF values
                 for (const auto & node : ordered_nodes)
                   for (auto comp : make_range(node->n_comp(sys_num,var)))
                     {
                       libmesh_assert_not_equal_to (node->dof_number(sys_num, var, comp),
                                                    DofObject::invalid_id);
 
                       io_buffer.push_back((*vec)(node->dof_number(sys_num, var, comp)));
                     }
 
                 // Then write the element DOF values
                 for (const auto & elem : ordered_elements)
                   for (auto comp : make_range(elem->n_comp(sys_num,var)))
                     {
                       libmesh_assert_not_equal_to (elem->dof_number(sys_num, var, comp),
                                                    DofObject::invalid_id);
 
                       io_buffer.push_back((*vec)(elem->dof_number(sys_num, var, comp)));
                     }
               }
 
           // Finally, write the SCALAR data on the last processor
           for (auto var : make_range(this->n_vars()))
             if (this->variable(var).type().family == SCALAR)
               {
                 if (this->processor_id() == (this->n_processors()-1))
                   {
                     const DofMap & dof_map = this->get_dof_map();
                     std::vector<dof_id_type> SCALAR_dofs;
                     dof_map.SCALAR_dof_indices(SCALAR_dofs, var);
 
                     for (auto dof : SCALAR_dofs)
                       io_buffer.push_back((*vec)(dof));
                   }
               }
 
           // 10.)
           //
           // Actually write the reordered additional vector
           // for this system to disk
 
           // set up the comment
           {
             comment = "# System \"";
             comment += this->name();
             comment += "\" Additional Vector \"";
             comment += vec_name;
             comment += "\"";
           }
 
           io.data (io_buffer, comment);
 
           // total_written_size += io_buffer.size();
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_written_size*sizeof(Number)/dt;
 
   // libMesh::err << "Write " << total_written_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("write_parallel_data");
 }

◆ write_SCALAR_dofs()

unsigned int libMesh::System::write_SCALAR_dofs	(	const NumericVector< Number > &	vec,
		const unsigned int	var,
		Xdr &	io
	)		const

private

Writes the SCALAR dofs associated with var to the stream io.

Returns: The number of values written.

Definition at line 2062 of file system_io.C.

References libMesh::ParallelObject::comm(), libMesh::Xdr::data_stream(), get_dof_map(), TIMPI::Communicator::get_unique_tag(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::processor_id(), TIMPI::Communicator::receive(), libMesh::DofMap::SCALAR_dof_indices(), and TIMPI::Communicator::send().

Referenced by write_serialized_vector(), and write_serialized_vectors().

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

◆ 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

private

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 1776 of file system_io.C.

References TIMPI::Communicator::broadcast(), libMesh::ParallelObject::comm(), TIMPI::Communicator::get_unique_tag(), libMesh::MeshTools::Generation::Private::idx(), libMesh::invalid_uint, libMesh::libmesh_assert(), libMesh::make_range(), libMesh::ParallelObject::n_processors(), n_vars(), number(), libMesh::ParallelObject::processor_id(), TIMPI::Communicator::receive(), TIMPI::Communicator::send(), and TIMPI::Status::source().

Referenced by write_serialized_vector(), and write_serialized_vectors().

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

◆ write_serialized_data()

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

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 1668 of file system_io.C.

References _vectors, libMesh::Xdr::comment(), name(), libMesh::ParallelObject::processor_id(), solution, and write_serialized_vector().

Referenced by libMesh::TransientRBConstruction::write_riesz_representors_to_files(), and libMesh::RBConstruction::write_riesz_representors_to_files().

 {
   parallel_object_only();
   std::string comment;
 
   // PerfLog pl("IO Performance",false);
   // pl.push("write_serialized_data");
   // std::size_t total_written_size = 0;
 
   // total_written_size +=
   this->write_serialized_vector(io, *this->solution);
 
   // set up the comment
   if (this->processor_id() == 0)
     {
       comment = "# System \"";
       comment += this->name();
       comment += "\" Solution Vector";
 
       io.comment (comment);
     }
 
   // Only write additional vectors if wanted
   if (write_additional_data)
     {
       for (auto & pair : this->_vectors)
         {
           // total_written_size +=
           this->write_serialized_vector(io, *pair.second);
 
           // set up the comment
           if (this->processor_id() == 0)
             {
               comment = "# System \"";
               comment += this->name();
               comment += "\" Additional Vector \"";
               comment += pair.first;
               comment += "\"";
               io.comment (comment);
             }
         }
     }
 
   // const Real
   //   dt   = pl.get_elapsed_time(),
   //   rate = total_written_size*sizeof(Number)/dt;
 
   // libMesh::out << "Write " << total_written_size << " \"Number\" values\n"
   //     << " Elapsed time = " << dt << '\n'
   //     << " Rate = " << rate/1.e6 << "(MB/sec)\n\n";
 
   // pl.pop("write_serialized_data");
 
 
 
 
   // // test the new method
   // {
   //   std::vector<std::string> names;
   //   std::vector<NumericVector<Number> *> vectors_to_write;
 
   //   names.push_back("Solution Vector");
   //   vectors_to_write.push_back(this->solution.get());
 
   //   // Only write additional vectors if wanted
   //   if (write_additional_data)
   //     {
   // std::map<std::string, NumericVector<Number> *>::const_iterator
   //   pos = _vectors.begin();
 
   // for (; pos != this->_vectors.end(); ++pos)
   //   {
   //     names.push_back("Additional Vector " + pos->first);
   //     vectors_to_write.push_back(pos->second);
   //   }
   //     }
 
   //   total_written_size =
   //     this->write_serialized_vectors (io, names, vectors_to_write);
 
   //   const Real
   //     dt2   = pl.get_elapsed_time(),
   //     rate2 = total_written_size*sizeof(Number)/(dt2-dt);
 
   //   libMesh::out << "Write (new) " << total_written_size << " \"Number\" values\n"
   //       << " Elapsed time = " << (dt2-dt) << '\n'
   //       << " Rate = " << rate2/1.e6 << "(MB/sec)\n\n";
 
   // }
 }

◆ write_serialized_vector()

dof_id_type libMesh::System::write_serialized_vector	(	Xdr &	io,
		const NumericVector< Number > &	vec
	)		const

private

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 2118 of file system_io.C.

References libMesh::Xdr::data(), libMesh::FEType::family, get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshTools::n_elem(), n_nodes, n_vars(), libMesh::ParallelObject::processor_id(), libMesh::SCALAR, libMesh::NumericVector< T >::size(), libMesh::Variable::type(), variable(), write_SCALAR_dofs(), write_serialized_blocked_dof_objects(), and libMesh::Xdr::writing().

Referenced by write_serialized_data().

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

◆ write_serialized_vectors()

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

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 2259 of file system_io.C.

References libMesh::Xdr::data(), get_mesh(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::MeshTools::n_elem(), libMesh::MeshBase::n_elem(), n_nodes, libMesh::MeshBase::n_nodes(), n_vars(), libMesh::ParallelObject::processor_id(), libMesh::SCALAR, variable(), write_SCALAR_dofs(), write_serialized_blocked_dof_objects(), and libMesh::Xdr::writing().

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

 {
   parallel_object_only();
 
   libmesh_assert (io.writing());
 
   // Cache these - they are not free!
   const dof_id_type
     n_nodes       = this->get_mesh().n_nodes(),
     n_elem        = this->get_mesh().n_elem();
 
   std::size_t written_length = 0;
 
   if (this->processor_id() == 0)
     {
       unsigned int
         n_vec    = cast_int<unsigned int>(vectors.size());
       dof_id_type
         vec_size = vectors.empty() ? 0 : vectors[0]->size();
       // Set the number of vectors
       io.data(n_vec, "# number of vectors");
       // Set the buffer size
       io.data(vec_size, "# vector length");
     }
 
   //---------------------------------
   // Collect the values for all nodes
   written_length +=
     this->write_serialized_blocked_dof_objects (vectors,
                                                 n_nodes,
                                                 this->get_mesh().local_nodes_begin(),
                                                 this->get_mesh().local_nodes_end(),
                                                 io);
 
   //------------------------------------
   // Collect the values for all elements
   written_length +=
     this->write_serialized_blocked_dof_objects (vectors,
                                                 n_elem,
                                                 this->get_mesh().local_elements_begin(),
                                                 this->get_mesh().local_elements_end(),
                                                 io);
 
   //-------------------------------------------
   // Finally loop over all the SCALAR variables
   for (const NumericVector<Number> * vec : vectors)
     for (auto var : make_range(this->n_vars()))
       if (this->variable(var).type().family == SCALAR)
         {
           libmesh_assert_not_equal_to (vec, 0);
 
           written_length +=
             this->write_SCALAR_dofs (*vec, var, io);
         }
 
   return written_length;
 }

◆ zero_variable()

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

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

Definition at line 1616 of file system.C.

References get_mesh(), mesh, n_vars(), number(), and libMesh::NumericVector< T >::set().

 {
   /* Make sure the call makes sense.  */
   libmesh_assert_less (var_num, this->n_vars());
 
   /* Get a reference to the mesh.  */
   const MeshBase & mesh = this->get_mesh();
 
   /* Check which system we are.  */
   const unsigned int sys_num = this->number();
 
   // Loop over nodes.
   for (const auto & node : mesh.local_node_ptr_range())
     {
       unsigned int n_comp = node->n_comp(sys_num,var_num);
       for (unsigned int i=0; i<n_comp; i++)
         {
           const dof_id_type index = node->dof_number(sys_num,var_num,i);
           v.set(index,0.0);
         }
     }
 
   // Loop over elements.
   for (const auto & elem : mesh.active_local_element_ptr_range())
     {
       unsigned int n_comp = elem->n_comp(sys_num,var_num);
       for (unsigned int i=0; i<n_comp; i++)
         {
           const dof_id_type index = elem->dof_number(sys_num,var_num,i);
           v.set(index,0.0);
         }
     }
 }

Member Data Documentation

◆ _active

bool libMesh::System::_active

private

Flag stating if the system is active or not.

Definition at line 2156 of file system.h.

Referenced by activate(), active(), and deactivate().

◆ _additional_data_written

unsigned int libMesh::System::_additional_data_written

private

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

Referenced by read_header(), read_legacy_data(), read_parallel_data(), and read_serialized_data().

◆ _assemble_system_function

void(* libMesh::System::_assemble_system_function) (EquationSystems &es, const std::string &name)

private

Function that assembles the system.

Definition at line 2064 of file system.h.

Referenced by attach_assemble_function(), attach_assemble_object(), and user_assembly().

◆ _assemble_system_object

Assembly* libMesh::System::_assemble_system_object

private

Object that assembles the system.

Definition at line 2070 of file system.h.

Referenced by attach_assemble_function(), attach_assemble_object(), and user_assembly().

◆ _basic_system_only

bool libMesh::System::_basic_system_only

private

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

system matrices) should not be initialized.

Definition at line 2204 of file system.h.

Referenced by init(), init_data(), reinit(), reinit_mesh(), and 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::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), libMesh::ParallelObject::processor_id(), and libMesh::BoundaryInfo::regenerate_id_sets().

◆ _constrain_system_function

void(* libMesh::System::_constrain_system_function) (EquationSystems &es, const std::string &name)

private

Function to impose constraints.

Definition at line 2075 of file system.h.

Referenced by attach_constraint_function(), attach_constraint_object(), and user_constrain().

◆ _constrain_system_object

Constraint* libMesh::System::_constrain_system_object

private

Object that constrains the system.

Definition at line 2081 of file system.h.

Referenced by attach_constraint_function(), attach_constraint_object(), get_constraint_object(), has_constraint_object(), and user_constrain().

◆ _counts

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

◆ _dof_map

std::unique_ptr<DofMap> libMesh::System::_dof_map

private

Data structure describing the relationship between nodes, variables, etc...

and degrees of freedom.

Definition at line 2113 of file system.h.

Referenced by add_vector(), calculate_norm(), clear(), current_solution(), get_dof_map(), init_data(), n_constrained_dofs(), n_dofs(), n_local_constrained_dofs(), n_local_dofs(), restrict_vectors(), and update().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

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

private

Constant reference to the EquationSystems object used for the simulation.

Definition at line 2119 of file system.h.

Referenced by get_equation_systems(), user_assembly(), user_constrain(), user_initialization(), user_QOI(), and user_QOI_derivative().

◆ _hide_output

bool libMesh::System::_hide_output

private

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

Definition at line 2248 of file system.h.

Referenced by hide_output().

◆ _identify_variable_groups

bool libMesh::System::_identify_variable_groups

private

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

Defaults to true.

Definition at line 2216 of file system.h.

Referenced by identify_variable_groups().

◆ _init_system_function

void(* libMesh::System::_init_system_function) (EquationSystems &es, const std::string &name)

private

Function that initializes the system.

Definition at line 2053 of file system.h.

Referenced by attach_init_function(), attach_init_object(), and user_initialization().

◆ _init_system_object

Initialization* libMesh::System::_init_system_object

private

Object that initializes the system.

Definition at line 2059 of file system.h.

Referenced by attach_init_function(), attach_init_object(), and user_initialization().

◆ _is_initialized

bool libMesh::System::_is_initialized

private

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

Definition at line 2210 of file system.h.

Referenced by add_vector(), clear(), compare(), init_data(), and is_initialized().

◆ _matrices

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

private

Some systems need an arbitrary number of matrices.

Definition at line 2181 of file system.h.

Referenced by add_matrix(), clear(), get_matrix(), have_matrix(), init_data(), init_matrices(), n_matrices(), reinit(), remove_matrix(), and request_matrix().

◆ _matrices_initialized

bool libMesh::System::_matrices_initialized

private

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

Definition at line 2191 of file system.h.

Referenced by can_add_matrices(), clear(), init_matrices(), and late_matrix_init().

◆ _matrix_types

std::map<std::string, ParallelType, std::less<> > libMesh::System::_matrix_types

private

Holds the types of the matrices.

Definition at line 2186 of file system.h.

Referenced by add_matrix(), and init_matrices().

◆ _mesh

MeshBase& libMesh::System::_mesh

private

Constant reference to the mesh data structure used for the simulation.

Definition at line 2125 of file system.h.

Referenced by calculate_norm(), get_mesh(), and reinit_constraints().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

◆ _n_objects

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

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 132 of file reference_counter.h.

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

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

private

Function to evaluate quantity of interest derivative.

Definition at line 2098 of file system.h.

Referenced by attach_QOI_derivative(), attach_QOI_derivative_object(), and user_QOI_derivative().

◆ _qoi_evaluate_derivative_object

QOIDerivative* libMesh::System::_qoi_evaluate_derivative_object

private

Object to compute derivatives of quantities of interest.

Definition at line 2107 of file system.h.

Referenced by attach_QOI_derivative(), attach_QOI_derivative_object(), and user_QOI_derivative().

◆ _qoi_evaluate_function

void(* libMesh::System::_qoi_evaluate_function) (EquationSystems &es, const std::string &name, const QoISet &qoi_indices)

private

Function to evaluate quantity of interest.

Definition at line 2086 of file system.h.

Referenced by attach_QOI_function(), attach_QOI_object(), and user_QOI().

◆ _qoi_evaluate_object

QOI* libMesh::System::_qoi_evaluate_object

private

Object to compute quantities of interest.

Definition at line 2093 of file system.h.

Referenced by attach_QOI_function(), attach_QOI_object(), and user_QOI().

◆ _solution_projection

bool libMesh::System::_solution_projection

private

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

Referenced by project_solution_on_reinit(), and restrict_vectors().

◆ _sys_name

const std::string libMesh::System::_sys_name

private

A name associated with this system.

Definition at line 2130 of file system.h.

Referenced by compare(), and name().

◆ _sys_number

const unsigned int libMesh::System::_sys_number

private

The number associated with this system.

Definition at line 2135 of file system.h.

Referenced by number().

◆ _variable_groups

std::vector<VariableGroup> libMesh::System::_variable_groups

private

The VariableGroup in this System.

Definition at line 2145 of file system.h.

Referenced by add_variable(), add_variables(), n_variable_groups(), and variable_group().

◆ _variable_numbers

std::map<std::string, unsigned int, std::less<> > libMesh::System::_variable_numbers

private

The variable numbers corresponding to user-specified names, useful for name-based lookups.

Definition at line 2151 of file system.h.

Referenced by add_variable(), add_variables(), clear(), get_all_variable_numbers(), has_variable(), and variable_number().

◆ _variables

std::vector<Variable> libMesh::System::_variables

private

The Variable in this System.

Definition at line 2140 of file system.h.

Referenced by add_variable(), add_variables(), clear(), n_components(), n_vars(), variable(), variable_name(), variable_number(), variable_scalar_number(), and variable_type().

◆ _vector_is_adjoint

std::map<std::string, int, std::less<> > libMesh::System::_vector_is_adjoint

private

Holds non-negative if a vector by that name should be projected using adjoint constraints/BCs, -1 if primal.

Definition at line 2176 of file system.h.

Referenced by add_vector(), clear(), remove_vector(), set_vector_as_adjoint(), and vector_is_adjoint().

◆ _vector_projections

std::map<std::string, bool, std::less<> > libMesh::System::_vector_projections

private

Holds true if a vector by that name should be projected onto a changed grid, false if it should be zeroed.

Definition at line 2170 of file system.h.

Referenced by add_vector(), clear(), remove_vector(), restrict_vectors(), set_vector_preservation(), vector_preservation(), and write_header().

◆ _vectors

std::map<std::string, std::unique_ptr<NumericVector<Number> >, std::less<> > libMesh::System::_vectors

private

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

Referenced by add_vector(), clear(), compare(), get_vector(), have_vector(), init_data(), n_vectors(), read_legacy_data(), read_parallel_data(), read_serialized_data(), remove_vector(), request_vector(), restrict_vectors(), vector_name(), vectors_begin(), vectors_end(), write_header(), write_parallel_data(), and write_serialized_data().

◆ _written_var_indices

std::vector<unsigned int> libMesh::System::_written_var_indices

private

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

Referenced by read_header(), read_legacy_data(), read_parallel_data(), read_serialized_blocked_dof_objects(), and read_serialized_vector().

◆ adjoint_already_solved

bool libMesh::System::adjoint_already_solved

private

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

Referenced by is_adjoint_already_solved(), and set_adjoint_already_solved().

◆ assemble_before_solve

bool libMesh::System::assemble_before_solve

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

Referenced by libMesh::ImplicitSystem::adjoint_solve(), libMesh::ImplicitSystem::disable_cache(), disable_cache(), main(), libMesh::RBConstruction::RBConstruction(), libMesh::RBSCMConstruction::RBSCMConstruction(), libMesh::ImplicitSystem::sensitivity_solve(), libMesh::EigenSystem::solve(), libMesh::CondensedEigenSystem::solve(), and libMesh::LinearImplicitSystem::solve().

◆ current_local_solution

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

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 1585 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(), HDGProblem::assemble(), libMesh::NonlinearImplicitSystem::assembly(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), clear(), libMesh::Problem_Interface::computeF(), libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), current_solution(), DMlibMeshFunction(), DMlibMeshJacobian(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), fe_assembly(), init_data(), libMesh::libmesh_petsc_snes_fd_residual(), libMesh::libmesh_petsc_snes_jacobian(), libMesh::libmesh_petsc_snes_mffd_residual(), libMesh::libmesh_petsc_snes_residual(), libMesh::libmesh_petsc_snes_residual_helper(), point_gradient(), point_hessian(), point_value(), libMesh::FEMContext::pre_fe_reinit(), libMesh::RBEIMEvaluation::project_qp_data_map_onto_system(), re_update(), reinit(), restrict_vectors(), OverlappingAlgebraicGhostingTest::run_ghosting_test(), OverlappingCouplingGhostingTest::run_sparsity_pattern_test(), SolidSystem::save_initial_mesh(), libMesh::RBConstruction::set_context_solution_vec(), setup(), MeshFunctionTest::test_subdomain_id_sets(), MeshInputTest::testCopyElementVectorImpl(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::TransientRBConstruction::truth_solve(), update(), libMesh::Nemesis_IO_Helper::write_element_values(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

◆ extra_quadrature_order

int libMesh::System::extra_quadrature_order

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

Referenced by CurlCurlSystem::init_data(), and set_system_parameters().

◆ project_with_constraints

bool libMesh::System::project_with_constraints

private

Do we want to apply constraints while projecting vectors ?

Definition at line 2253 of file system.h.

Referenced by get_project_with_constraints(), and set_project_with_constraints().

◆ qoi

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

private

Values of the quantities of interest.

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

Definition at line 1611 of file system.h.

Referenced by libMesh::DifferentiableSystem::attach_qoi(), get_qoi_value(), get_qoi_values(), init_qois(), n_qois(), and set_qoi().

◆ qoi_error_estimates

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

private

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.

Definition at line 1619 of file system.h.

Referenced by get_qoi_error_estimate_value(), init_qois(), n_qois(), and set_qoi_error_estimate().

◆ solution

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

Data structure to hold solution values.

Definition at line 1573 of file system.h.

◆ time

Real libMesh::System::time

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

Referenced by libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubProjector::construct_projection(), HeatSystem::element_qoi(), fill_dirichlet_bc(), libMesh::ExactErrorEstimator::find_squared_element_error(), initialize(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::UnsteadySolver::integrate_adjoint_sensitivity(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), main(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), reinit_constraints(), libMesh::UnsteadySolver::retrieve_timestep(), and libMesh::TwostepTimeSolver::solve().

◆ use_fixed_solution

bool libMesh::System::use_fixed_solution

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

Referenced by libMesh::EulerSolver::_general_residual(), libMesh::Euler2Solver::_general_residual(), libMesh::SteadySolver::_general_residual(), libMesh::NewmarkSolver::_general_residual(), libMesh::DifferentiableSystem::clear(), libMesh::DiffContext::DiffContext(), and libMesh::FEMContext::pre_fe_reinit().

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

include/systems/system.h
src/systems/system.C
src/systems/system_io.C
src/systems/system_projection.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_matrices_iterator

◆ const_vectors_iterator

◆ Counts

◆ GradientFunctionPointer

◆ matrices_iterator

◆ sys_type

◆ ValueFunctionPointer

◆ vectors_iterator

Constructor & Destructor Documentation

◆ System() [1/3]

◆ System() [2/3]

◆ System() [3/3]

◆ ~System()

Member Function Documentation

◆ activate()

◆ active()

◆ add_adjoint_rhs()

◆ add_adjoint_solution()

◆ add_matrices()

◆ add_matrix() [1/2]

◆ add_matrix() [2/2]

◆ add_sensitivity_rhs()

◆ add_sensitivity_solution()

◆ add_variable() [1/2]

◆ add_variable() [2/2]

◆ add_variables() [1/2]

◆ add_variables() [2/2]

◆ add_vector()

◆ add_weighted_sensitivity_adjoint_solution()

◆ add_weighted_sensitivity_solution()

◆ adjoint_qoi_parameter_sensitivity()

◆ adjoint_solve()

◆ assemble()

◆ assemble_qoi()

◆ assemble_qoi_derivative()

◆ assemble_residual_derivatives()

◆ attach_assemble_function()

◆ attach_assemble_object()

◆ attach_constraint_function()

◆ attach_constraint_object()

◆ attach_init_function()

◆ attach_init_object()

◆ attach_QOI_derivative()

◆ attach_QOI_derivative_object()

◆ attach_QOI_function()

◆ attach_QOI_object()

◆ boundary_project_solution() [1/2]

◆ boundary_project_solution() [2/2]

◆ boundary_project_vector() [1/2]

◆ boundary_project_vector() [2/2]

◆ calculate_norm() [1/2]

◆ calculate_norm() [2/2]

◆ can_add_matrices()

◆ clear()

◆ comm()

◆ compare()

◆ current_solution()

◆ deactivate()

◆ disable_cache()

◆ disable_print_counter_info()

◆ discrete_var_norm()

◆ enable_print_counter_info()

◆ forward_qoi_parameter_sensitivity()

◆ get_adjoint_rhs() [1/2]

◆ get_adjoint_rhs() [2/2]

◆ get_adjoint_solution() [1/2]

◆ get_adjoint_solution() [2/2]