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

#include <transient_rb_construction.h>

Inheritance diagram for libMesh::TransientRBConstruction:

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

typedef TransientSystem< RBConstruction >	Parent
	The type of the parent. More...

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

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

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

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

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

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

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

virtual	~TransientRBConstruction ()
	Destructor. More...

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

virtual void	initialize_rb_construction (bool skip_matrix_assembly=false, bool skip_vector_assembly=false) override
	Allocate all the data structures necessary for the construction stage of the RB method. More...

virtual Real	truth_solve (int write_interval) override
	Perform a truth solve at the current parameter. More...

virtual Real	train_reduced_basis (const bool resize_rb_eval_data=true) override
	Train the reduced basis. More...

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

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

virtual bool	greedy_termination_test (Real abs_greedy_error, Real initial_greedy_error, int count) override
	Function that indicates when to terminate the Greedy basis training. More...

virtual void	assemble_all_affine_operators () override
	Assemble and store all the affine operators. More...

virtual void	assemble_misc_matrices () override
	Override to assemble the L2 matrix as well. More...

void	assemble_L2_matrix (SparseMatrix< Number > *input_matrix, bool apply_dirichlet_bc=true)
	Assemble the L2 matrix. More...

void	assemble_mass_matrix (SparseMatrix< Number > *input_matrix)
	Assemble the mass matrix at the current parameter and store it in input_matrix. More...

void	add_scaled_mass_matrix (Number scalar, SparseMatrix< Number > *input_matrix)
	Add the scaled mass matrix (assembled for the current parameter) to input_matrix. More...

void	mass_matrix_scaled_matvec (Number scalar, NumericVector< Number > &dest, NumericVector< Number > &arg)
	Perform a matrix-vector multiplication with the current mass matrix and store the result in dest. More...

void	set_L2_assembly (ElemAssembly &L2_assembly_in)
	Set the L2 object. More...

ElemAssembly &	get_L2_assembly ()

void	assemble_Mq_matrix (unsigned int q, SparseMatrix< Number > *input_matrix, bool apply_dirichlet_bc=true)
	Assemble the q^th affine term of the mass matrix and store it in input_matrix. More...

SparseMatrix< Number > *	get_M_q (unsigned int q)
	Get a pointer to M_q. More...

SparseMatrix< Number > *	get_non_dirichlet_M_q (unsigned int q)
	Get a pointer to non_dirichlet_M_q. More...

virtual void	get_all_matrices (std::map< std::string, SparseMatrix< Number > *> &all_matrices) override
	Get a map that stores pointers to all of the matrices. More...

virtual void	truth_assembly () override
	Assemble the truth system in the transient linear case. More...

int	get_max_truth_solves () const
	Get/set max_truth_solves, the maximum number of RB truth solves we are willing to compute in the transient case. More...

void	set_max_truth_solves (int max_truth_solves_in)

Real	get_POD_tol () const
	Get/set POD_tol. More...

void	set_POD_tol (const Real POD_tol_in)

void	set_delta_N (const unsigned int new_delta_N)
	Set delta_N, the number of basis functions we add to the RB space from each POD. More...

virtual void	load_rb_solution () override
	Load the RB solution from the current time-level into the libMesh solution vector. More...

const NumericVector< Number > &	get_error_temporal_data ()
	Get the column of temporal_data corresponding to the current time level. More...

void	update_RB_initial_condition_all_N ()
	Compute the L2 projection of the initial condition onto the RB space for 1 <= N <= RB_size and store each projection in RB_initial_condition_matrix. More...

virtual void	write_riesz_representors_to_files (const std::string &riesz_representors_dir, const bool write_binary_residual_representors) override
	Write out all the Riesz representor data to files. More...

virtual void	read_riesz_representors_from_files (const std::string &riesz_representors_dir, const bool write_binary_residual_representors) override
	Write out all the Riesz representor data to files. More...

sys_type &	system ()

virtual std::string	system_type () const override

Number	old_solution (const dof_id_type global_dof_number) const

Number	older_solution (const dof_id_type global_dof_number) const

virtual void	solve_for_matrix_and_rhs (LinearSolver< Number > &input_solver, SparseMatrix< Number > &input_matrix, NumericVector< Number > &input_rhs)
	Assembles & solves the linear system A*x=b for the specified matrix `input_matrix` and right-hand side `rhs`. More...

void	set_rb_evaluation (RBEvaluation &rb_eval_in)
	Set the RBEvaluation object. More...

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

bool	is_rb_eval_initialized () const

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

void	set_rb_assembly_expansion (RBAssemblyExpansion &rb_assembly_expansion_in)
	Set the rb_assembly_expansion object. More...

RBAssemblyExpansion &	get_rb_assembly_expansion ()

void	enrich_basis_from_rhs_terms (const bool resize_rb_eval_data=true)
	This function computes one basis function for each rhs term. More...

virtual Real	compute_max_error_bound ()
	(i) Compute the a posteriori error bound for each set of parameters in the training set, (ii) set current_parameters to the parameters that maximize the error bound, and (iii) return the maximum error bound. More...

const RBParameters &	get_greedy_parameter (unsigned int i)
	Return the parameters chosen during the i^th step of the Greedy algorithm. More...

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

Real	get_rel_training_tolerance ()

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

Real	get_abs_training_tolerance ()

void	set_normalize_rb_bound_in_greedy (bool normalize_rb_bound_in_greedy_in)
	Get/set the boolean to indicate if we normalize the RB error in the greedy. More...

bool	get_normalize_rb_bound_in_greedy ()

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

virtual void	set_Nmax (unsigned int Nmax)

virtual void	load_basis_function (unsigned int i)
	Load the i^th RB function into the RBConstruction solution vector. More...

SparseMatrix< Number > *	get_inner_product_matrix ()
	Get a pointer to inner_product_matrix. More...

SparseMatrix< Number > *	get_non_dirichlet_inner_product_matrix ()
	Get the non-Dirichlet (or more generally no-constraints) version of the inner-product matrix. More...

SparseMatrix< Number > *	get_non_dirichlet_inner_product_matrix_if_avail ()
	Get the non-Dirichlet inner-product matrix if it's available, otherwise get the inner-product matrix with constraints. More...

SparseMatrix< Number > *	get_Aq (unsigned int q)
	Get a pointer to Aq. More...

SparseMatrix< Number > *	get_non_dirichlet_Aq (unsigned int q)
	Get a pointer to non_dirichlet_Aq. More...

SparseMatrix< Number > *	get_non_dirichlet_Aq_if_avail (unsigned int q)
	Get a pointer to non_dirichlet_Aq if it's available, otherwise get Aq. More...

NumericVector< Number > *	get_Fq (unsigned int q)
	Get a pointer to Fq. More...

NumericVector< Number > *	get_non_dirichlet_Fq (unsigned int q)
	Get a pointer to non-Dirichlet Fq. More...

NumericVector< Number > *	get_non_dirichlet_Fq_if_avail (unsigned int q)
	Get a pointer to non_dirichlet_Fq if it's available, otherwise get Fq. More...

NumericVector< Number > *	get_output_vector (unsigned int n, unsigned int q_l)
	Get a pointer to the n^th output. More...

NumericVector< Number > *	get_non_dirichlet_output_vector (unsigned int n, unsigned int q_l)
	Get a pointer to non-Dirichlet output vector. More...

virtual void	get_all_vectors (std::map< std::string, NumericVector< Number > *> &all_vectors)
	Get a map that stores pointers to all of the vectors. More...

virtual void	get_output_vectors (std::map< std::string, NumericVector< Number > *> &all_vectors)
	Get a map that stores pointers to all of the vectors. More...

void	assemble_inner_product_matrix (SparseMatrix< Number > *input_matrix, bool apply_dof_constraints=true)
	Assemble the inner product matrix and store it in input_matrix. More...

void	assemble_Aq_matrix (unsigned int q, SparseMatrix< Number > *input_matrix, bool apply_dof_constraints=true)
	Assemble the q^th affine matrix and store it in input_matrix. More...

void	assemble_Fq_vector (unsigned int q, NumericVector< Number > *input_vector, bool apply_dof_constraints=true)
	Assemble the q^th affine vector and store it in input_matrix. More...

void	add_scaled_Aq (Number scalar, unsigned int q_a, SparseMatrix< Number > *input_matrix, bool symmetrize)
	Add the scaled q^th affine matrix to input_matrix. More...

virtual void	recompute_all_residual_terms (const bool compute_inner_products=true)
	This function computes all of the residual representors, can be useful when restarting a basis training computation. More...

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

void	print_basis_function_orthogonality ()
	Print out a matrix that shows the orthogonality of the RB basis functions. More...

unsigned int	get_delta_N () const
	Get delta_N, the number of basis functions we add to the RB space per iteration of the greedy algorithm. More...

void	set_inner_product_assembly (ElemAssembly &inner_product_assembly_in)
	Set the rb_assembly_expansion object. More...

ElemAssembly &	get_inner_product_assembly ()

void	zero_constrained_dofs_on_vector (NumericVector< Number > &vector)
	It is sometimes useful to be able to zero vector entries that correspond to constrained dofs. More...

void	set_convergence_assertion_flag (bool flag)
	Setter for the flag determining if convergence should be checked after each solve. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	solve () override
	Assembles & solves the linear system A*x=b. More...

virtual LinearSolver< Number > *	get_linear_solver () const override

virtual void	release_linear_solver (LinearSolver< Number > *) const override
	Releases a pointer to a linear solver acquired by `this->get_linear_solver()` More...

virtual void	assembly (bool get_residual, bool get_jacobian, bool apply_heterogeneous_constraints=false, bool apply_no_constraints=false) override
	Assembles a residual in `rhs` and/or a jacobian in `matrix`, as requested. More...

unsigned int	n_linear_iterations () const

Real	final_linear_residual () const

void	attach_shell_matrix (ShellMatrix< Number > *shell_matrix)
	This function enables the user to provide a shell matrix, i.e. More...

void	detach_shell_matrix ()
	Detaches a shell matrix. More...

ShellMatrix< Number > *	get_shell_matrix ()

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

virtual std::pair< unsigned int, Real >	get_linear_solve_parameters () const

virtual void	assemble_residual_derivatives (const ParameterVector &parameters) override
	Residual parameter derivative function. More...

virtual std::pair< unsigned int, Real >	sensitivity_solve (const ParameterVector &parameters) override
	Assembles & solves the linear system(s) (dR/du)*u_p = -dR/dp, for those parameters contained within `parameters`. More...

virtual std::pair< unsigned int, Real >	weighted_sensitivity_solve (const ParameterVector &parameters, const ParameterVector &weights) override
	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()) override
	Assembles & solves the linear system (dR/du)^T*z = dq/du, for those quantities of interest q specified by `qoi_indices`. More...

virtual std::pair< unsigned int, Real >	weighted_sensitivity_adjoint_solve (const ParameterVector &parameters, const ParameterVector &weights, const QoISet &qoi_indices=QoISet()) override
	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...

virtual void	adjoint_qoi_parameter_sensitivity (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &sensitivities) override
	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	forward_qoi_parameter_sensitivity (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &sensitivities) override
	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	qoi_parameter_hessian (const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &hessian) override
	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) override
	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...

SparseMatrix< Number > &	add_matrix (const std::string &mat_name)
	Adds the additional matrix `mat_name` to this system. More...

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

bool	have_matrix (const std::string &mat_name) const

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

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

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

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

virtual unsigned int	n_matrices () const override

virtual void	assemble_qoi (const QoISet &qoi_indices=QoISet()) override
	Prepares `qoi` for quantity of interest assembly, then calls user qoi function. More...

virtual void	assemble_qoi_derivative (const QoISet &qoi_indices=QoISet(), bool include_liftfunc=true, bool apply_constraints=true) override
	Prepares `adjoint_rhs` for quantity of interest derivative assembly, then calls user qoi derivative function. More...

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

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

bool	is_initialized ()

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

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 bool	compare (const System &other_system, const Real threshold, const bool verbose) const

const std::string &	name () const

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

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

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

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

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

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

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

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

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

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

unsigned int	number () const

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

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

const MeshBase &	get_mesh () const

MeshBase &	get_mesh ()

const DofMap &	get_dof_map () const

DofMap &	get_dof_map ()

const EquationSystems &	get_equation_systems () const

EquationSystems &	get_equation_systems ()

bool	active () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

NumericVector< Number > &	add_weighted_sensitivity_solution ()

NumericVector< Number > &	get_weighted_sensitivity_solution ()

const NumericVector< Number > &	get_weighted_sensitivity_solution () const

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

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

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

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

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

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

unsigned int	n_vectors () const

unsigned int	n_vars () const

unsigned int	n_variable_groups () const

unsigned int	n_components () const

dof_id_type	n_dofs () const

dof_id_type	n_active_dofs () const

dof_id_type	n_constrained_dofs () const

dof_id_type	n_local_constrained_dofs () const

dof_id_type	n_local_dofs () const

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

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

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

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

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

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

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

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

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

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

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

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

const FEType &	variable_type (const unsigned int i) const

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

bool	identify_variable_groups () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

std::string	get_info () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Number	current_solution (const dof_id_type global_dof_number) const

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

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

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

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

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

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

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

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

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

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

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

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

bool &	hide_output ()

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

void	initialize_parameters (const RBParameters &mu_min_in, const RBParameters &mu_max_in, const std::map< std::string, std::vector< Real >> &discrete_parameter_values)
	Initialize the parameter ranges and set current_parameters. More...

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

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

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

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

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

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

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

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

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

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

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

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

void	write_parameter_data_to_files (const std::string &continuous_param_file_name, const std::string &discrete_param_file_name, const bool write_binary_data)
	Write out the parameter ranges to files. More...

void	read_parameter_data_from_files (const std::string &continuous_param_file_name, const std::string &discrete_param_file_name, const bool read_binary_data)
	Read in the parameter ranges from files. More...

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

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

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

Real	get_delta_t () const
	Get/set delta_t, the time-step size. More...

void	set_delta_t (const Real delta_t_in)

Real	get_euler_theta () const
	Get/set euler_theta, parameter that determines the temporal discretization. More...

void	set_euler_theta (const Real euler_theta_in)

unsigned int	get_time_step () const
	Get/set the current time-step. More...

void	set_time_step (const unsigned int k)

unsigned int	get_n_time_steps () const
	Get/set the total number of time-steps. More...

void	set_n_time_steps (const unsigned int K)

Real	get_control (const unsigned int k) const
	Get/set the RHS control. More...

void	set_control (const std::vector< Real > &control)

void	process_temporal_parameters_file (const std::string &parameters_filename)
	Read in and initialize parameters from `parameters_filename`. More...

void	pull_temporal_discretization_data (RBTemporalDiscretization &other)
	Pull the temporal discretization data from `other`. More...

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

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

static std::unique_ptr< DirichletBoundary >	build_zero_dirichlet_boundary_object ()
	It's helpful to be able to generate a DirichletBoundary that stores a ZeroFunction in order to impose Dirichlet boundary conditions. More...

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

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

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

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

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

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

static void	disable_print_counter_info ()

static void	disable_print_counter_info ()

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

Public Attributes
std::unique_ptr< SparseMatrix< Number > >	L2_matrix
	The L2 matrix. More...

std::unique_ptr< SparseMatrix< Number > >	non_dirichlet_L2_matrix
	The L2 matrix without Dirichlet conditions enforced. More...

std::vector< std::unique_ptr< SparseMatrix< Number > > >	M_q_vector
	Vector storing the Q_m matrices from the mass operator. More...

std::vector< std::unique_ptr< SparseMatrix< Number > > >	non_dirichlet_M_q_vector
	We sometimes also need a second set of M_q matrices that do not have the Dirichlet boundary conditions enforced. More...

std::vector< std::vector< Number > >	truth_outputs_all_k
	The truth outputs for all time-levels from the most recent truth_solve. More...

bool	nonzero_initialization
	Boolean flag to indicate whether we are using a non-zero initialization. More...

bool	compute_truth_projection_error
	Boolean flag that indicates whether we will compute the projection error for the truth solution into the RB space (at every time level). More...

std::string	init_filename
	The filename of the file containing the initial condition projected onto the truth mesh. More...

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

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

std::vector< Real >	training_error_bounds
	Vector storing the values of the error bound for each parameter in the training set — the parameter giving the largest error bound is chosen for the next snapshot in the Greedy basis training. More...

std::unique_ptr< LinearSolver< Number > >	inner_product_solver
	We store an extra linear solver object which we can optionally use for solving all systems in which the system matrix is set to inner_product_matrix. More...

LinearSolver< Number > *	extra_linear_solver
	Also, we store a pointer to an extra linear solver. More...

std::unique_ptr< SparseMatrix< Number > >	inner_product_matrix
	The inner product matrix. More...

std::vector< Number >	truth_outputs
	Vector storing the truth output values from the most recent truth solve. More...

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

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

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

bool	skip_residual_in_train_reduced_basis
	Boolean flag to indicate if we skip residual calculations in train_reduced_basis. More...

bool	exit_on_repeated_greedy_parameters
	Boolean flag to indicate whether we exit the greedy if we select the same parameters twice in a row. More...

bool	impose_internal_fluxes
	Boolean flag to indicate whether we impose "fluxes" (i.e. More...

bool	skip_degenerate_sides
	In some cases meshes are intentionally created with degenerate sides as a way to represent, say, triangles using a hex-only mesh. More...

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

bool	store_non_dirichlet_operators
	Boolean flag to indicate whether we store a second copy of each affine operator and vector which does not have Dirichlet bcs enforced. More...

bool	use_empty_rb_solve_in_greedy
	A boolean flag to indicate whether or not we initialize the Greedy algorithm by performing rb_solves on the training set with an "empty" (i.e. More...

bool	Fq_representor_innerprods_computed
	A boolean flag to indicate whether or not the Fq representor norms have already been computed — used to make sure that we don't recompute them unnecessarily. More...

std::unique_ptr< LinearSolver< Number > >	linear_solver
	The `LinearSolver` defines the interface used to solve the linear_implicit system. More...

SparseMatrix< Number > *	matrix
	The system matrix. More...

bool	zero_out_matrix_and_rhs
	By default, the system will zero out the matrix and the right hand side. More...

NumericVector< Number > *	rhs
	The system matrix. More...

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

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

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

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

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

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

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

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

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

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

Protected Member Functions
virtual void	allocate_data_structures () override
	Helper function that actually allocates all the data structures required by this class. More...

virtual void	assemble_affine_expansion (bool skip_matrix_assembly, bool skip_vector_assembly) override
	Override assemble_affine_expansion to also initialize RB_ic_proj_rhs_all_N, if necessary. More...

virtual void	initialize_truth ()
	This function imposes a truth initial condition, defaults to zero initial condition if the flag nonzero_initialization is true. More...

virtual SparseMatrix< Number > &	get_matrix_for_output_dual_solves () override
	Override to return the L2 product matrix for output dual norm solves for transient state problems. More...

void	add_IC_to_RB_space ()
	Initialize RB space by adding the truth initial condition as the first RB basis function. More...

virtual void	enrich_RB_space () override
	Add a new basis functions to the RB space. More...

virtual void	update_system () override
	Update the system after enriching the RB space. More...

virtual void	update_RB_system_matrices () override
	Compute the reduced basis matrices for the current basis. More...

virtual void	update_residual_terms (bool compute_inner_products) override
	Compute the terms that are combined ‘online’ to determine the dual norm of the residual. More...

Number	set_error_temporal_data ()
	Set column k (i.e. More...

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

virtual std::unique_ptr< DGFEMContext >	build_context ()
	Builds a DGFEMContext object with enough information to do evaluations on each element. More...

void	update_greedy_param_list ()
	Update the list of Greedily chosen parameters with current_parameters. More...

void	add_scaled_matrix_and_vector (Number scalar, ElemAssembly elem_assembly, SparseMatrix< Number > input_matrix, NumericVector< Number > *input_vector, bool symmetrize=false, bool apply_dof_constraints=true)
	This function loops over the mesh and applies the specified interior and/or boundary assembly routines, then adds the scaled result to input_matrix and/or input_vector. More...

virtual void	set_context_solution_vec (NumericVector< Number > &vec)
	Set current_local_solution = vec so that we can access vec from FEMContext during assembly. More...

virtual void	assemble_all_affine_vectors ()
	Assemble and store the affine RHS vectors. More...

virtual void	assemble_all_output_vectors ()
	Assemble and store the output vectors. More...

virtual void	compute_output_dual_innerprods ()
	Compute and store the dual norm of each output functional. More...

virtual void	compute_Fq_representor_innerprods (bool compute_inner_products=true)
	Compute the terms that are combined ‘online’ to determine the dual norm of the residual. More...

virtual Real	get_RB_error_bound ()

virtual void	init_context (FEMContext &)
	Initialize the FEMContext prior to performing an element loop. More...

bool	get_convergence_assertion_flag () const
	Getter for the flag determining if convergence should be checked after each solve. More...

void	check_convergence (LinearSolver< Number > &input_solver)
	Check if the linear solver reports convergence. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
Real	POD_tol
	If positive, this tolerance determines the number of POD modes we add to the space on a call to enrich_RB_space(). More...

int	max_truth_solves
	Maximum number of truth solves in the POD-Greedy. More...

ElemAssembly *	L2_assembly
	Function pointer for assembling the L2 matrix. More...

DenseVector< Number >	RB_ic_proj_rhs_all_N
	The vector that stores the right-hand side for the initial condition projections. More...

unsigned int	Nmax
	Maximum number of reduced basis functions we are willing to use. More...

unsigned int	delta_N
	The number of basis functions that we add at each greedy step. More...

bool	output_dual_innerprods_computed
	A boolean flag to indicate whether or not the output dual norms have already been computed — used to make sure that we don't recompute them unnecessarily. More...

bool	assert_convergence
	A boolean flag to indicate whether to check for proper convergence after each solve. More...

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

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

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

unsigned int	_n_linear_iterations
	The number of linear iterations required to solve the linear system Ax=b. More...

Real	_final_linear_residual
	The final residual for the linear system Ax=b. More...

ShellMatrix< Number > *	_shell_matrix
	User supplies shell matrix or `nullptr` if no shell matrix is used. More...

const SystemSubset *	_subset
	The current subset on which to solve (or `nullptr` if none). More...

SubsetSolveMode	_subset_solve_mode
	If restrict-solve-to-subset mode is active, this member decides what happens with the dofs outside the subset. More...

const Parallel::Communicator &	_communicator

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

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

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

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

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

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

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

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

Private Attributes
std::vector< std::unique_ptr< NumericVector< Number > > >	temporal_data
	Dense matrix to store the data that we use for the temporal POD. More...

Detailed Description

This class is part of the rbOOmit framework.

TransientRBConstruction extends RBConstruction to add functionality relevant in the time-dependent case.

We can handle time controls on the RHS as h(t)*f(x, $\mu$ ). See Martin Grepl's thesis for more details.

Author: David J. Knezevic

Date: 2009

Definition at line 48 of file transient_rb_construction.h.

Member Typedef Documentation

◆ const_matrices_iterator

typedef std::map<std::string, SparseMatrix<Number> *>::const_iterator libMesh::ImplicitSystem::const_matrices_iterator

inherited

Definition at line 306 of file implicit_system.h.

◆ const_vectors_iterator

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

inherited

Definition at line 749 of file system.h.

◆ Counts [1/2]

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

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

◆ Counts [2/2]

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

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

◆ GradientFunctionPointer

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

inherited

Definition at line 524 of file system.h.

◆ matrices_iterator

typedef std::map<std::string, SparseMatrix<Number> *>::iterator libMesh::ImplicitSystem::matrices_iterator

inherited

Matrix iterator typedefs.

Definition at line 305 of file implicit_system.h.

◆ Parent

typedef TransientSystem<RBConstruction> libMesh::TransientRBConstruction::Parent

The type of the parent.

Definition at line 73 of file transient_rb_construction.h.

◆ sys_type

typedef TransientRBConstruction libMesh::TransientRBConstruction::sys_type

The type of system.

Definition at line 68 of file transient_rb_construction.h.

◆ ValueFunctionPointer

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

inherited

Projects arbitrary functions onto the current solution.

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

Definition at line 520 of file system.h.

◆ vectors_iterator

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

inherited

Vector iterator typedefs.

Definition at line 748 of file system.h.

Constructor & Destructor Documentation

◆ TransientRBConstruction()

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

Constructor.

Optionally initializes required data structures.

◆ ~TransientRBConstruction()

virtual libMesh::TransientRBConstruction::~TransientRBConstruction ( )

virtual

Destructor.

Member Function Documentation

◆ activate()

void libMesh::System::activate ( )

inherited

Activates the system.

Only active systems are solved.

Definition at line 2073 of file system.h.

References libMesh::System::_active.

 {
   _active = true;
 }

◆ active()

bool libMesh::System::active ( ) const

inherited

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

Definition at line 2065 of file system.h.

References libMesh::System::_active.

 {
   return _active;
 }

◆ add_adjoint_rhs()

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

inherited

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

◆ add_adjoint_solution()

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

inherited

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

◆ add_IC_to_RB_space()

void libMesh::TransientRBConstruction::add_IC_to_RB_space ( )

protected

Initialize RB space by adding the truth initial condition as the first RB basis function.

◆ add_matrix()

SparseMatrix<Number>& libMesh::ImplicitSystem::add_matrix ( const std::string & mat_name )

inherited

Adds the additional matrix mat_name to this system.

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

◆ add_scaled_Aq()

void libMesh::RBConstruction::add_scaled_Aq	(	Number	scalar,
		unsigned int	q_a,
		SparseMatrix< Number > *	input_matrix,
		bool	symmetrize
	)

inherited

Add the scaled q^th affine matrix to input_matrix.

If symmetrize==true, then we symmetrize Aq before adding it.

◆ add_scaled_mass_matrix()

void libMesh::TransientRBConstruction::add_scaled_mass_matrix	(	Number	scalar,
		SparseMatrix< Number > *	input_matrix
	)

Add the scaled mass matrix (assembled for the current parameter) to input_matrix.

◆ add_scaled_matrix_and_vector()

void libMesh::RBConstruction::add_scaled_matrix_and_vector	(	Number	scalar,
		ElemAssembly *	elem_assembly,
		SparseMatrix< Number > *	input_matrix,
		NumericVector< Number > *	input_vector,
		bool	symmetrize = `false`,
		bool	apply_dof_constraints = `true`
	)

protectedinherited

This function loops over the mesh and applies the specified interior and/or boundary assembly routines, then adds the scaled result to input_matrix and/or input_vector.

If symmetrize==true then we assemble the symmetric part of the matrix, 0.5*(A + A^T)

◆ add_sensitivity_rhs()

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

inherited

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

◆ add_sensitivity_solution()

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

inherited

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

◆ add_variable() [1/2]

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

inherited

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

Returns: The index number for the new variable.

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

◆ add_variable() [2/2]

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

inherited

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

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

◆ add_variables() [1/2]

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

inherited

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

Returns: The index number for the new variable.

◆ add_variables() [2/2]

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

inherited

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

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

◆ add_vector()

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

inherited

Adds the additional vector vec_name to this system.

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

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

◆ add_weighted_sensitivity_adjoint_solution()

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

inherited

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

◆ add_weighted_sensitivity_solution()

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

inherited

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

◆ adjoint_qoi_parameter_sensitivity()

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

overridevirtualinherited

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

Uses adjoint_solve() and the adjoint sensitivity method.

Currently uses finite differenced derivatives (partial q / partial p) and (partial R / partial p).

Reimplemented from libMesh::System.

◆ adjoint_solve()

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

overridevirtualinherited

Assembles & solves the linear system (dR/du)^T*z = dq/du, for those quantities of interest q specified by qoi_indices.

Leave qoi_indices empty to solve all adjoint problems.

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

Reimplemented from libMesh::System.

Reimplemented in libMesh::DifferentiableSystem.

◆ allocate_data_structures()

virtual void libMesh::TransientRBConstruction::allocate_data_structures ( )

overrideprotectedvirtual

Helper function that actually allocates all the data structures required by this class.

Reimplemented from libMesh::RBConstruction.

◆ assemble()

virtual void libMesh::LinearImplicitSystem::assemble ( )

overridevirtualinherited

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 from libMesh::ImplicitSystem.

Reimplemented in libMesh::FrequencySystem, and libMesh::NewmarkSystem.

Definition at line 110 of file linear_implicit_system.h.

References libMesh::ImplicitSystem::assemble().

110 { ImplicitSystem::assemble(); }

libMesh::ImplicitSystem::assemble

virtual void assemble() override

Prepares matrix and rhs for system assembly, then calls user assembly function.

◆ assemble_affine_expansion()

virtual void libMesh::TransientRBConstruction::assemble_affine_expansion	(	bool	skip_matrix_assembly,
		bool	skip_vector_assembly
	)

overrideprotectedvirtual

Override assemble_affine_expansion to also initialize RB_ic_proj_rhs_all_N, if necessary.

Reimplemented from libMesh::RBConstruction.

◆ assemble_all_affine_operators()

virtual void libMesh::TransientRBConstruction::assemble_all_affine_operators ( )

overridevirtual

Assemble and store all the affine operators.

Override to assemble the mass matrix operators.

Reimplemented from libMesh::RBConstruction.

◆ assemble_all_affine_vectors()

virtual void libMesh::RBConstruction::assemble_all_affine_vectors ( )

protectedvirtualinherited

Assemble and store the affine RHS vectors.

◆ assemble_all_output_vectors()

virtual void libMesh::RBConstruction::assemble_all_output_vectors ( )

protectedvirtualinherited

Assemble and store the output vectors.

◆ assemble_Aq_matrix()

void libMesh::RBConstruction::assemble_Aq_matrix	(	unsigned int	q,
		SparseMatrix< Number > *	input_matrix,
		bool	apply_dof_constraints = `true`
	)

inherited

Assemble the q^th affine matrix and store it in input_matrix.

◆ assemble_Fq_vector()

void libMesh::RBConstruction::assemble_Fq_vector	(	unsigned int	q,
		NumericVector< Number > *	input_vector,
		bool	apply_dof_constraints = `true`
	)

inherited

Assemble the q^th affine vector and store it in input_matrix.

◆ assemble_inner_product_matrix()

void libMesh::RBConstruction::assemble_inner_product_matrix	(	SparseMatrix< Number > *	input_matrix,
		bool	apply_dof_constraints = `true`
	)

inherited

Assemble the inner product matrix and store it in input_matrix.

◆ assemble_L2_matrix()

void libMesh::TransientRBConstruction::assemble_L2_matrix	(	SparseMatrix< Number > *	input_matrix,
		bool	apply_dirichlet_bc = `true`
	)

Assemble the L2 matrix.

◆ assemble_mass_matrix()

void libMesh::TransientRBConstruction::assemble_mass_matrix ( SparseMatrix< Number > * input_matrix )

Assemble the mass matrix at the current parameter and store it in input_matrix.

◆ assemble_misc_matrices()

virtual void libMesh::TransientRBConstruction::assemble_misc_matrices ( )

overridevirtual

Override to assemble the L2 matrix as well.

Reimplemented from libMesh::RBConstruction.

◆ assemble_Mq_matrix()

void libMesh::TransientRBConstruction::assemble_Mq_matrix	(	unsigned int	q,
		SparseMatrix< Number > *	input_matrix,
		bool	apply_dirichlet_bc = `true`
	)

Assemble the q^th affine term of the mass matrix and store it in input_matrix.

◆ assemble_qoi()

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

overridevirtualinherited

Prepares qoi for quantity of interest assembly, then calls user qoi function.

Can be overridden in derived classes.

Reimplemented from libMesh::System.

Reimplemented in libMesh::FEMSystem.

◆ assemble_qoi_derivative()

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

overridevirtualinherited

Prepares adjoint_rhs for quantity of interest derivative assembly, then calls user qoi derivative function.

Can be overridden in derived classes.

Reimplemented from libMesh::System.

Reimplemented in libMesh::FEMSystem.

◆ assemble_residual_derivatives()

virtual void libMesh::ImplicitSystem::assemble_residual_derivatives ( const ParameterVector & parameters )

overridevirtualinherited

Residual parameter derivative function.

Uses finite differences by default.

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

Can be overridden in derived classes.

Reimplemented from libMesh::System.

◆ assembly()

virtual void libMesh::LinearImplicitSystem::assembly	(	bool	get_residual,
		bool	get_jacobian,
		bool	apply_heterogeneous_constraints = `false`,
		bool	apply_no_constraints = `false`
	)

overridevirtualinherited

Assembles a residual in rhs and/or a jacobian in matrix, as requested.

Reimplemented from libMesh::ImplicitSystem.

◆ attach_assemble_function()

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

inherited

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

◆ attach_assemble_object()

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

inherited

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

◆ attach_constraint_function()

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

inherited

Register a user function for imposing constraints.

◆ attach_constraint_object()

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

inherited

Register a user object for imposing constraints.

◆ attach_init_function()

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

inherited

Register a user function to use in initializing the system.

◆ attach_init_object()

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

inherited

Register a user class to use to initialize the system.

Note: This is exclusive with the attach_init_function.

◆ attach_QOI_derivative()

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

inherited

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

◆ attach_QOI_derivative_object()

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

inherited

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

◆ attach_QOI_function()

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

inherited

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

◆ attach_QOI_object()

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

inherited

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

◆ attach_shell_matrix()

void libMesh::LinearImplicitSystem::attach_shell_matrix ( ShellMatrix< Number > * shell_matrix )

inherited

This function enables the user to provide a shell matrix, i.e.

a matrix that is not stored element-wise, but as a function. When you register your shell matrix using this function, calling solve() will no longer use the matrix member but the registered shell matrix instead. You can reset this behaviour to its original state by supplying a nullptr to this function.

Referenced by libMesh::LinearImplicitSystem::detach_shell_matrix().

◆ boundary_project_solution() [1/2]

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

inherited

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

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

◆ boundary_project_solution() [2/2]

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

inherited

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

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

◆ boundary_project_vector() [1/2]

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

inherited

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

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

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

◆ boundary_project_vector() [2/2]

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

inherited

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

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

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

◆ broadcast_parameters()

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

inherited

Broadcasts parameters on processor proc_id to all processors.

◆ build_context()

virtual std::unique_ptr<DGFEMContext> libMesh::RBConstruction::build_context ( )

protectedvirtualinherited

Builds a DGFEMContext object with enough information to do evaluations on each element.

We use DGFEMContext since it allows for both DG and continuous Galerkin formulations.

◆ build_zero_dirichlet_boundary_object()

static std::unique_ptr<DirichletBoundary> libMesh::RBConstruction::build_zero_dirichlet_boundary_object ( )

staticinherited

It's helpful to be able to generate a DirichletBoundary that stores a ZeroFunction in order to impose Dirichlet boundary conditions.

Referenced by SimpleRBConstruction::init_data().

◆ calculate_norm() [1/2]

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

inherited

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

◆ calculate_norm() [2/2]

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

inherited

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

◆ check_convergence()

void libMesh::RBConstruction::check_convergence ( LinearSolver< Number > & input_solver )

protectedinherited

Check if the linear solver reports convergence.

Throw an error when that is not the case.

◆ clear()

virtual void libMesh::TransientRBConstruction::clear ( )

overridevirtual

Clear all the data structures associated with the system.

Reimplemented from libMesh::TransientSystem< RBConstruction >.

◆ comm()

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

inherited

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

Definition at line 89 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

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

90 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ compare()

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

virtualinherited

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

◆ compute_Fq_representor_innerprods()

virtual void libMesh::RBConstruction::compute_Fq_representor_innerprods ( bool compute_inner_products = true )

protectedvirtualinherited

Compute the terms that are combined ‘online’ to determine the dual norm of the residual.

Here we compute the terms associated with the right-hand side. These terms are basis independent, hence we separate them from the rest of the calculations that are done in update_residual_terms. By default, inner product terms are also computed, but you can turn this feature off e.g. if you are already reading in that data from files.

◆ compute_max_error_bound()

virtual Real libMesh::RBConstruction::compute_max_error_bound ( )

virtualinherited

(i) Compute the a posteriori error bound for each set of parameters in the training set, (ii) set current_parameters to the parameters that maximize the error bound, and (iii) return the maximum error bound.

◆ compute_output_dual_innerprods()

virtual void libMesh::RBConstruction::compute_output_dual_innerprods ( )

protectedvirtualinherited

Compute and store the dual norm of each output functional.

◆ current_solution()

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

inherited

Returns: The current solution for the specified global DOF.

◆ deactivate()

void libMesh::System::deactivate ( )

inherited

Deactivates the system.

Only active systems are solved.

Definition at line 2081 of file system.h.

References libMesh::System::_active.

 {
   _active = false;
 }

◆ detach_shell_matrix()

void libMesh::LinearImplicitSystem::detach_shell_matrix ( )

inherited

Detaches a shell matrix.

Same as attach_shell_matrix(nullptr).

Definition at line 185 of file linear_implicit_system.h.

References libMesh::LinearImplicitSystem::attach_shell_matrix().

185 { attach_shell_matrix(nullptr); }

libMesh::LinearImplicitSystem::attach_shell_matrix

void attach_shell_matrix(ShellMatrix< Number > *shell_matrix)

This function enables the user to provide a shell matrix, i.e.

◆ disable_cache()

virtual void libMesh::ImplicitSystem::disable_cache ( )

overridevirtualinherited

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

Should be overridden in derived systems.

Reimplemented from libMesh::System.

◆ disable_print_counter_info() [1/2]

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ disable_print_counter_info() [2/2]

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ enable_print_counter_info() [1/2]

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ enable_print_counter_info() [2/2]

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ enrich_basis_from_rhs_terms()

void libMesh::RBConstruction::enrich_basis_from_rhs_terms ( const bool resize_rb_eval_data = true )

inherited

This function computes one basis function for each rhs term.

This is useful in some cases since we can avoid doing a full greedy if we know that we do not have any "left-hand side" parameters, for example.

◆ enrich_RB_space()

virtual void libMesh::TransientRBConstruction::enrich_RB_space ( )

overrideprotectedvirtual

Add a new basis functions to the RB space.

In the transient case we first perform a POD of the time-dependent "truth" and then add a certain number of POD modes to the reduced basis.

Reimplemented from libMesh::RBConstruction.

◆ final_linear_residual()

Real libMesh::LinearImplicitSystem::final_linear_residual ( ) const

inherited

Returns: The final residual for the linear system solve.

Definition at line 169 of file linear_implicit_system.h.

References libMesh::LinearImplicitSystem::_final_linear_residual.

169 { return _final_linear_residual; }

libMesh::LinearImplicitSystem::_final_linear_residual

Real _final_linear_residual

The final residual for the linear system Ax=b.

Definition: linear_implicit_system.h:204

◆ forward_qoi_parameter_sensitivity()

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

overridevirtualinherited

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

Uses the forward sensitivity method.

Currently uses finite differenced derivatives (partial q / partial p) and (partial R / partial p).

Reimplemented from libMesh::System.

◆ generate_training_parameters_deterministic()

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

staticprotectedinherited

Static helper function for generating a deterministic set of parameters.

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

◆ generate_training_parameters_random()

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

staticprotectedinherited

Static helper function for generating a randomized set of parameters.

◆ get_abs_training_tolerance()

Real libMesh::RBConstruction::get_abs_training_tolerance ( )

inherited

Definition at line 193 of file rb_construction.h.

References libMesh::RBConstruction::abs_training_tolerance.

193 { return abs_training_tolerance; }

libMesh::RBConstruction::abs_training_tolerance

Real abs_training_tolerance

Definition: rb_construction.h:802

◆ get_adjoint_rhs() [1/2]

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

inherited

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

◆ get_adjoint_rhs() [2/2]

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

inherited

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

◆ get_adjoint_solution() [1/2]

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

inherited

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

◆ get_adjoint_solution() [2/2]

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

inherited

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

◆ get_all_matrices()

virtual void libMesh::TransientRBConstruction::get_all_matrices ( std::map< std::string, SparseMatrix< Number > *> & all_matrices )

overridevirtual

Get a map that stores pointers to all of the matrices.

Reimplemented from libMesh::RBConstruction.

◆ get_all_variable_numbers()

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

inherited

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

◆ get_all_vectors()

virtual void libMesh::RBConstruction::get_all_vectors ( std::map< std::string, NumericVector< Number > *> & all_vectors )

virtualinherited

Get a map that stores pointers to all of the vectors.

◆ get_Aq()

SparseMatrix<Number>* libMesh::RBConstruction::get_Aq ( unsigned int q )

inherited

Get a pointer to Aq.

◆ get_closest_value()

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

staticinherited

Returns: The closest entry to value from list_of_values.

◆ get_control()

Real libMesh::RBTemporalDiscretization::get_control ( const unsigned int k ) const

inherited

Get/set the RHS control.

◆ get_convergence_assertion_flag()

bool libMesh::RBConstruction::get_convergence_assertion_flag ( ) const

protectedinherited

Getter for the flag determining if convergence should be checked after each solve.

◆ get_delta_N()

unsigned int libMesh::RBConstruction::get_delta_N ( ) const

inherited

Get delta_N, the number of basis functions we add to the RB space per iteration of the greedy algorithm.

For steady-state systems, this should be 1, but can be more than 1 for time-dependent systems.

Definition at line 411 of file rb_construction.h.

References libMesh::RBConstruction::delta_N.

411 { return delta_N; }

libMesh::RBConstruction::delta_N

unsigned int delta_N

The number of basis functions that we add at each greedy step.

Definition: rb_construction.h:733

◆ get_delta_t()

Real libMesh::RBTemporalDiscretization::get_delta_t ( ) const

inherited

Get/set delta_t, the time-step size.

◆ get_deterministic_training_parameter_name()

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

inherited

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

◆ get_deterministic_training_parameter_repeats()

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

inherited

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

◆ get_discrete_parameter_values()

const std::map<std::string, std::vector<Real> >& libMesh::RBParametrized::get_discrete_parameter_values ( ) const

inherited

Get a const reference to the discrete parameter values.

◆ get_dof_map() [1/2]

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

inherited

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

Definition at line 2049 of file system.h.

References libMesh::System::_dof_map.

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

 {
   return *_dof_map;
 }

◆ get_dof_map() [2/2]

DofMap & libMesh::System::get_dof_map ( )

inherited

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

Definition at line 2057 of file system.h.

References libMesh::System::_dof_map.

 {
   return *_dof_map;
 }

◆ get_equation_systems() [1/2]

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

inherited

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

Definition at line 712 of file system.h.

References libMesh::System::_equation_systems.

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

712 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:1890

◆ get_equation_systems() [2/2]

EquationSystems& libMesh::System::get_equation_systems ( )

inherited

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

Definition at line 717 of file system.h.

References libMesh::System::_equation_systems.

717 { return _equation_systems; }

libMesh::System::_equation_systems

EquationSystems & _equation_systems

Constant reference to the EquationSystems object used for the simulation.

Definition: system.h:1890

◆ get_error_temporal_data()

const NumericVector<Number>& libMesh::TransientRBConstruction::get_error_temporal_data ( )

Get the column of temporal_data corresponding to the current time level.

This gives access to the truth projection error data. If the RB basis is empty, then this corresponds to the truth solution data itself.

◆ get_euler_theta()

Real libMesh::RBTemporalDiscretization::get_euler_theta ( ) const

inherited

Get/set euler_theta, parameter that determines the temporal discretization.

◆ get_first_local_training_index()

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

inherited

Get the first local index of the training parameters.

◆ get_Fq()

NumericVector<Number>* libMesh::RBConstruction::get_Fq ( unsigned int q )

inherited

Get a pointer to Fq.

◆ get_global_max_error_pair()

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

staticprotectedinherited

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

◆ get_greedy_parameter()

const RBParameters& libMesh::RBConstruction::get_greedy_parameter ( unsigned int i )

inherited

Return the parameters chosen during the i^th step of the Greedy algorithm.

◆ get_info() [1/3]

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

staticinherited

Gets a string containing the reference information.

◆ get_info() [2/3]

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

staticinherited

Gets a string containing the reference information.

◆ get_info() [3/3]

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

inherited

Returns: A string containing information about the system.

◆ get_inner_product_assembly()

ElemAssembly& libMesh::RBConstruction::get_inner_product_assembly ( )

inherited

Returns: A reference to the inner product assembly object

◆ get_inner_product_matrix()

SparseMatrix<Number>* libMesh::RBConstruction::get_inner_product_matrix ( )

inherited

Get a pointer to inner_product_matrix.

Accessing via this function, rather than directly through the class member allows us to do error checking (e.g. inner_product_matrix is not defined in low-memory mode).

◆ get_L2_assembly()

ElemAssembly& libMesh::TransientRBConstruction::get_L2_assembly ( )

Returns: A reference to the L2 assembly object

◆ get_last_local_training_index()

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

inherited

Get the last local index of the training parameters.

◆ get_linear_solve_parameters()

virtual std::pair<unsigned int, Real> libMesh::ImplicitSystem::get_linear_solve_parameters ( ) const

virtualinherited

Returns: An integer corresponding to the upper iteration count limit and a Real corresponding to the convergence tolerance to be used in linear adjoint and/or sensitivity solves

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

◆ get_linear_solver()

virtual LinearSolver<Number>* libMesh::LinearImplicitSystem::get_linear_solver ( ) const

overridevirtualinherited

Returns: A pointer to a linear solver appropriate for use in adjoint and/or sensitivity solves

Reimplemented from libMesh::ImplicitSystem.

◆ get_local_n_training_samples()

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

inherited

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

◆ get_M_q()

SparseMatrix<Number>* libMesh::TransientRBConstruction::get_M_q ( unsigned int q )

Get a pointer to M_q.

◆ get_matrix() [1/2]

const SparseMatrix<Number>& libMesh::ImplicitSystem::get_matrix ( const std::string & mat_name ) const

inherited

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

None of these matrices is involved in the solution process. Access is only granted when the matrix is already properly initialized.

◆ get_matrix() [2/2]

SparseMatrix<Number>& libMesh::ImplicitSystem::get_matrix ( const std::string & mat_name )

inherited

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

None of these matrices is involved in the solution process. Access is only granted when the matrix is already properly initialized.

◆ get_matrix_for_output_dual_solves()

virtual SparseMatrix<Number>& libMesh::TransientRBConstruction::get_matrix_for_output_dual_solves ( )

overrideprotectedvirtual

Override to return the L2 product matrix for output dual norm solves for transient state problems.

Reimplemented from libMesh::RBConstruction.

◆ get_max_truth_solves()

int libMesh::TransientRBConstruction::get_max_truth_solves ( ) const

Get/set max_truth_solves, the maximum number of RB truth solves we are willing to compute in the transient case.

Note: In the steady state case, max_truth_solves is not needed since it is equivalent to Nmax.

Definition at line 208 of file transient_rb_construction.h.

References max_truth_solves.

208 { return max_truth_solves; }

libMesh::TransientRBConstruction::max_truth_solves

int max_truth_solves

Maximum number of truth solves in the POD-Greedy.

Definition: transient_rb_construction.h:388

◆ get_mesh() [1/2]

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

inherited

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

Definition at line 2033 of file system.h.

References libMesh::System::_mesh.

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

 {
   return _mesh;
 }

◆ get_mesh() [2/2]

MeshBase & libMesh::System::get_mesh ( )

inherited

Returns: A reference to this systems's _mesh.

Definition at line 2041 of file system.h.

References libMesh::System::_mesh.

 {
   return _mesh;
 }

◆ get_n_continuous_params()

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

inherited

Get the number of continuous parameters.

◆ get_n_discrete_params()

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

inherited

Get the number of discrete parameters.

◆ get_n_params()

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

inherited

Get the number of parameters.

◆ get_n_time_steps()

unsigned int libMesh::RBTemporalDiscretization::get_n_time_steps ( ) const

inherited

Get/set the total number of time-steps.

◆ get_n_training_samples()

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

inherited

Get the total number of training samples.

◆ get_Nmax()

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

inherited

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

Definition at line 206 of file rb_construction.h.

References libMesh::RBConstruction::Nmax.

206 { return Nmax; }

libMesh::RBConstruction::Nmax

unsigned int Nmax

Maximum number of reduced basis functions we are willing to use.

Definition: rb_construction.h:727

◆ get_non_dirichlet_Aq()

SparseMatrix<Number>* libMesh::RBConstruction::get_non_dirichlet_Aq ( unsigned int q )

inherited

Get a pointer to non_dirichlet_Aq.

◆ get_non_dirichlet_Aq_if_avail()

SparseMatrix<Number>* libMesh::RBConstruction::get_non_dirichlet_Aq_if_avail ( unsigned int q )

inherited

Get a pointer to non_dirichlet_Aq if it's available, otherwise get Aq.

◆ get_non_dirichlet_Fq()

NumericVector<Number>* libMesh::RBConstruction::get_non_dirichlet_Fq ( unsigned int q )

inherited

Get a pointer to non-Dirichlet Fq.

◆ get_non_dirichlet_Fq_if_avail()

NumericVector<Number>* libMesh::RBConstruction::get_non_dirichlet_Fq_if_avail ( unsigned int q )

inherited

Get a pointer to non_dirichlet_Fq if it's available, otherwise get Fq.

◆ get_non_dirichlet_inner_product_matrix()

SparseMatrix<Number>* libMesh::RBConstruction::get_non_dirichlet_inner_product_matrix ( )

inherited

Get the non-Dirichlet (or more generally no-constraints) version of the inner-product matrix.

This is useful for performing multiplications on vectors that already have constraints enforced.

◆ get_non_dirichlet_inner_product_matrix_if_avail()

SparseMatrix<Number>* libMesh::RBConstruction::get_non_dirichlet_inner_product_matrix_if_avail ( )

inherited

Get the non-Dirichlet inner-product matrix if it's available, otherwise get the inner-product matrix with constraints.

◆ get_non_dirichlet_M_q()

SparseMatrix<Number>* libMesh::TransientRBConstruction::get_non_dirichlet_M_q ( unsigned int q )

Get a pointer to non_dirichlet_M_q.

◆ get_non_dirichlet_output_vector()

NumericVector<Number>* libMesh::RBConstruction::get_non_dirichlet_output_vector	(	unsigned int	n,
		unsigned int	q_l
	)

inherited

Get a pointer to non-Dirichlet output vector.

◆ get_normalize_rb_bound_in_greedy()

bool libMesh::RBConstruction::get_normalize_rb_bound_in_greedy ( )

inherited

Definition at line 200 of file rb_construction.h.

References libMesh::RBConstruction::normalize_rb_bound_in_greedy.

200 { return normalize_rb_bound_in_greedy; }

libMesh::RBConstruction::normalize_rb_bound_in_greedy

bool normalize_rb_bound_in_greedy

This boolean indicates if we normalize the RB error in the greedy using RBEvaluation::get_error_bound...

Definition: rb_construction.h:808

◆ get_output_vector()

NumericVector<Number>* libMesh::RBConstruction::get_output_vector	(	unsigned int	n,
		unsigned int	q_l
	)

inherited

Get a pointer to the n^th output.

◆ get_output_vectors()

virtual void libMesh::RBConstruction::get_output_vectors ( std::map< std::string, NumericVector< Number > *> & all_vectors )

virtualinherited

Get a map that stores pointers to all of the vectors.

◆ get_parameter_max()

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

inherited

Get maximum allowable value of parameter param_name.

◆ get_parameter_min()

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

inherited

Get minimum allowable value of parameter param_name.

◆ get_parameter_names()

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

inherited

Get a set that stores the parameter names.

◆ get_parameters()

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

inherited

Get the current parameters.

Referenced by SimpleRBEvaluation::get_stability_lower_bound().

◆ get_parameters_max()

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

inherited

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

◆ get_parameters_min()

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

inherited

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

◆ get_params_from_training_set()

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

protectedinherited

Return the RBParameters in index index of training set.

◆ get_POD_tol()

Real libMesh::TransientRBConstruction::get_POD_tol ( ) const

Get/set POD_tol.

Definition at line 214 of file transient_rb_construction.h.

References POD_tol.

214 { return POD_tol; }

libMesh::TransientRBConstruction::POD_tol

Real POD_tol

If positive, this tolerance determines the number of POD modes we add to the space on a call to enric...

Definition: transient_rb_construction.h:380

◆ get_rb_assembly_expansion()

RBAssemblyExpansion& libMesh::RBConstruction::get_rb_assembly_expansion ( )

inherited

Returns: A reference to the rb_assembly_expansion object

◆ get_RB_error_bound()

virtual Real libMesh::RBConstruction::get_RB_error_bound ( )

protectedvirtualinherited

Returns: The RB error bound for the current parameters.

Used in the Greedy algorithm to select the next parameter.

Reimplemented in libMesh::RBEIMConstruction.

◆ get_rb_evaluation()

RBEvaluation& libMesh::RBConstruction::get_rb_evaluation ( )

inherited

Get a reference to the RBEvaluation object.

◆ get_rb_theta_expansion()

RBThetaExpansion& libMesh::RBConstruction::get_rb_theta_expansion ( )

inherited

Get a reference to the RBThetaExpansion object that that belongs to rb_eval.

◆ get_rel_training_tolerance()

Real libMesh::RBConstruction::get_rel_training_tolerance ( )

inherited

Definition at line 186 of file rb_construction.h.

References libMesh::RBConstruction::rel_training_tolerance.

186 { return rel_training_tolerance; }

libMesh::RBConstruction::rel_training_tolerance

Real rel_training_tolerance

Relative and absolute tolerances for training reduced basis using the Greedy scheme.

Definition: rb_construction.h:801

◆ get_sensitivity_rhs() [1/2]

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

inherited

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

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

◆ get_sensitivity_rhs() [2/2]

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

inherited

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

◆ get_sensitivity_solution() [1/2]

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

inherited

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

◆ get_sensitivity_solution() [2/2]

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

inherited

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

◆ get_shell_matrix()

ShellMatrix<Number>* libMesh::LinearImplicitSystem::get_shell_matrix ( )

inherited

Returns: A pointer to the currently attached shell matrix, if any, otherwise nullptr.

Definition at line 191 of file linear_implicit_system.h.

References libMesh::LinearImplicitSystem::_shell_matrix.

191 { return _shell_matrix; }

libMesh::LinearImplicitSystem::_shell_matrix

ShellMatrix< Number > * _shell_matrix

User supplies shell matrix or nullptr if no shell matrix is used.

Definition: linear_implicit_system.h:209

◆ get_time_step()

unsigned int libMesh::RBTemporalDiscretization::get_time_step ( ) const

inherited

Get/set the current time-step.

◆ get_vector() [1/4]

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

inherited

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

◆ get_vector() [2/4]

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

inherited

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

◆ get_vector() [3/4]

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

inherited

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

◆ get_vector() [4/4]

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

inherited

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

◆ get_weighted_sensitivity_adjoint_solution() [1/2]

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

inherited

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

◆ get_weighted_sensitivity_adjoint_solution() [2/2]

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

inherited

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

◆ get_weighted_sensitivity_solution() [1/2]

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

inherited

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

◆ get_weighted_sensitivity_solution() [2/2]

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

inherited

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

◆ greedy_termination_test()

virtual bool libMesh::TransientRBConstruction::greedy_termination_test	(	Real	abs_greedy_error,
		Real	initial_greedy_error,
		int	count
	)

overridevirtual

Function that indicates when to terminate the Greedy basis training.

Reimplemented from libMesh::RBConstruction.

◆ has_variable()

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

inherited

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

◆ have_matrix()

bool libMesh::ImplicitSystem::have_matrix ( const std::string & mat_name ) const

inherited

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

Definition at line 419 of file implicit_system.h.

References libMesh::ImplicitSystem::_matrices.

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

◆ have_vector()

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

inherited

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

Definition at line 2225 of file system.h.

References libMesh::System::_vectors.

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

◆ hide_output()

bool& libMesh::System::hide_output ( )

inherited

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

Definition at line 1662 of file system.h.

References libMesh::System::_hide_output.

1662 { return _hide_output; }

libMesh::System::_hide_output

bool _hide_output

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

Definition: system.h:2009

◆ identify_variable_groups() [1/2]

bool libMesh::System::identify_variable_groups ( ) const

inherited

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

Definition at line 2201 of file system.h.

References libMesh::System::_identify_variable_groups.

 {
   return _identify_variable_groups;
 }

◆ identify_variable_groups() [2/2]

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

inherited

Toggle automatic VariableGroup identification.

Definition at line 2209 of file system.h.

References libMesh::System::_identify_variable_groups.

 {
   _identify_variable_groups = ivg;
 }

◆ increment_constructor_count() [1/2]

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

protectedinherited

Increments the construction counter.

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

Definition at line 181 of file reference_counter.h.

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

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

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.first++;
 }

◆ increment_constructor_count() [2/2]

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

protectedinherited

Increments the construction counter.

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

Definition at line 181 of file reference_counter.h.

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

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

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.first++;
 }

◆ increment_destructor_count() [1/2]

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

protectedinherited

Increments the destruction counter.

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

Definition at line 194 of file reference_counter.h.

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

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

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.second++;
 }

◆ increment_destructor_count() [2/2]

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

protectedinherited

Increments the destruction counter.

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

Definition at line 194 of file reference_counter.h.

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

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

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.second++;
 }

◆ init()

void libMesh::System::init ( )

inherited

Initializes degrees of freedom on the current mesh.

Sets the

◆ init_context()

virtual void libMesh::RBConstruction::init_context ( FEMContext & )

protectedvirtualinherited

Initialize the FEMContext prior to performing an element loop.

Reimplement this in derived classes in order to call FE::get_*() as the particular physics requires.

Reimplemented in SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, and ElasticityRBConstruction.

Definition at line 707 of file rb_construction.h.

707 {}

◆ init_data()

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

protectedvirtualinherited

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

Reimplemented from libMesh::LinearImplicitSystem.

Reimplemented in libMesh::RBEIMConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, SimpleRBConstruction, and ElasticityRBConstruction.

Referenced by SimpleRBConstruction::init_data().

◆ init_matrices()

virtual void libMesh::ImplicitSystem::init_matrices ( )

protectedvirtualinherited

Initializes the matrices associated with this system.

◆ initialize_parameters() [1/2]

void libMesh::RBParametrized::initialize_parameters	(	const RBParameters &	mu_min_in,
		const RBParameters &	mu_max_in,
		const std::map< std::string, std::vector< Real >> &	discrete_parameter_values
	)

inherited

Initialize the parameter ranges and set current_parameters.

◆ initialize_parameters() [2/2]

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

inherited

Initialize the parameter ranges and set current_parameters.

◆ initialize_rb_construction()

virtual void libMesh::TransientRBConstruction::initialize_rb_construction	(	bool	skip_matrix_assembly = `false`,
		bool	skip_vector_assembly = `false`
	)

overridevirtual

Allocate all the data structures necessary for the construction stage of the RB method.

This function also performs matrix and vector assembly of the "truth" affine expansion.

Override to check that theta and assembly expansions are consistently sized.

Reimplemented from libMesh::RBConstruction.

◆ initialize_training_parameters()

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

virtualinherited

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

◆ initialize_truth()

virtual void libMesh::TransientRBConstruction::initialize_truth ( )

protectedvirtual

This function imposes a truth initial condition, defaults to zero initial condition if the flag nonzero_initialization is true.

◆ is_adjoint_already_solved()

bool libMesh::System::is_adjoint_already_solved ( ) const

inherited

Accessor for the adjoint_already_solved boolean.

Definition at line 388 of file system.h.

References libMesh::System::adjoint_already_solved.

389 { return adjoint_already_solved;}

libMesh::System::adjoint_already_solved

bool adjoint_already_solved

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

Definition: system.h:2003

◆ is_discrete_parameter()

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

inherited

Is parameter mu_name discrete?

◆ is_initialized()

bool libMesh::System::is_initialized ( )

inherited

Returns: true iff this system has been initialized.

Definition at line 2089 of file system.h.

References libMesh::System::_is_initialized.

 {
   return _is_initialized;
 }

◆ is_quiet()

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

inherited

Is the system in quiet mode?

Definition at line 98 of file rb_construction_base.h.

99 { return this->quiet_mode; }

libMesh::RBConstructionBase< LinearImplicitSystem >::quiet_mode

bool quiet_mode

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

Definition: rb_construction_base.h:239

◆ is_rb_eval_initialized()

bool libMesh::RBConstruction::is_rb_eval_initialized ( ) const

inherited

Returns: true if rb_eval is initialized. False, otherwise.

◆ load_basis_function()

virtual void libMesh::RBConstruction::load_basis_function ( unsigned int i )

virtualinherited

Load the i^th RB function into the RBConstruction solution vector.

Reimplemented in libMesh::RBEIMConstruction.

◆ load_rb_solution()

virtual void libMesh::TransientRBConstruction::load_rb_solution ( )

overridevirtual

Load the RB solution from the current time-level into the libMesh solution vector.

Reimplemented from libMesh::RBConstruction.

◆ load_training_set()

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

virtualinherited

Overwrite the training parameters with new_training_set.

◆ local_dof_indices()

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

inherited

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

◆ mass_matrix_scaled_matvec()

void libMesh::TransientRBConstruction::mass_matrix_scaled_matvec	(	Number	scalar,
		NumericVector< Number > &	dest,
		NumericVector< Number > &	arg
	)

Perform a matrix-vector multiplication with the current mass matrix and store the result in dest.

◆ n_active_dofs()

dof_id_type libMesh::System::n_active_dofs ( ) const

inherited

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

Definition at line 2217 of file system.h.

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

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

◆ n_components()

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

inherited

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

Definition at line 2121 of file system.h.

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

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

◆ n_constrained_dofs()

dof_id_type libMesh::System::n_constrained_dofs ( ) const

inherited

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

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

◆ n_dofs()

dof_id_type libMesh::System::n_dofs ( ) const

inherited

Returns: The number of degrees of freedom in the system

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

◆ n_linear_iterations()

unsigned int libMesh::LinearImplicitSystem::n_linear_iterations ( ) const

inherited

Returns: The number of iterations taken for the most recent linear solve.

Definition at line 164 of file linear_implicit_system.h.

References libMesh::LinearImplicitSystem::_n_linear_iterations.

164 { return _n_linear_iterations; }

libMesh::LinearImplicitSystem::_n_linear_iterations

unsigned int _n_linear_iterations

The number of linear iterations required to solve the linear system Ax=b.

Definition: linear_implicit_system.h:199

◆ n_local_constrained_dofs()

dof_id_type libMesh::System::n_local_constrained_dofs ( ) const

inherited

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

◆ n_local_dofs()

dof_id_type libMesh::System::n_local_dofs ( ) const

inherited

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

◆ n_matrices()

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

overridevirtualinherited

Returns: The number of matrices handled by this system

Reimplemented from libMesh::System.

Definition at line 426 of file implicit_system.h.

References libMesh::ImplicitSystem::_matrices.

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

◆ n_objects() [1/2]

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

staticinherited

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

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ n_objects() [2/2]

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

staticinherited

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

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inherited

Returns: The number of processors in the group.

Definition at line 95 of file parallel_object.h.

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

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

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

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ n_qois()

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

inherited

Number of currently active quantities of interest.

Definition at line 2278 of file system.h.

References libMesh::System::qoi.

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

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

◆ n_variable_groups()

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

inherited

Returns: The number of VariableGroup variable groups in the system

Definition at line 2113 of file system.h.

References libMesh::System::_variable_groups.

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

◆ n_vars()

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

inherited

Returns: The number of variables in the system

Definition at line 2105 of file system.h.

References libMesh::System::_variables.

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

◆ n_vectors()

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

inherited

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

Definition at line 2233 of file system.h.

References libMesh::System::_vectors.

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

◆ name()

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

inherited

Returns: The system name.

Definition at line 2017 of file system.h.

References libMesh::System::_sys_name.

 {
   return _sys_name;
 }

◆ number()

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

inherited

Returns: The system number.

Definition at line 2025 of file system.h.

References libMesh::System::_sys_number.

 {
   return _sys_number;
 }

◆ old_solution()

Number libMesh::TransientSystem< RBConstruction >::old_solution ( const dof_id_type global_dof_number ) const

inherited

Returns: The old solution (at the previous timestep) for the specified global DOF.

◆ older_solution()

Number libMesh::TransientSystem< RBConstruction >::older_solution ( const dof_id_type global_dof_number ) const

inherited

Returns: The older solution (two timesteps ago) for the specified global DOF.

◆ point_gradient() [1/3]

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

inherited

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

◆ point_gradient() [2/3]

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

inherited

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

◆ point_gradient() [3/3]

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

inherited

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

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

◆ point_hessian() [1/3]

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

inherited

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

◆ point_hessian() [2/3]

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

inherited

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

◆ point_hessian() [3/3]

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

inherited

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

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

◆ point_value() [1/3]

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

inherited

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

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

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

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

◆ point_value() [2/3]

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

inherited

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

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

◆ point_value() [3/3]

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

inherited

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

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

◆ print_basis_function_orthogonality()

void libMesh::RBConstruction::print_basis_function_orthogonality ( )

inherited

Print out a matrix that shows the orthogonality of the RB basis functions.

This is a helpful debugging tool, e.g. orthogonality can be degraded due to finite precision arithmetic.

◆ print_discrete_parameter_values()

void libMesh::RBParametrized::print_discrete_parameter_values ( ) const

inherited

Print out all the discrete parameter values.

◆ print_info() [1/3]

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

staticinherited

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

◆ print_info() [2/3]

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

staticinherited

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

◆ print_info() [3/3]

virtual void libMesh::TransientRBConstruction::print_info ( )

overridevirtual

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

Reimplemented from libMesh::RBConstruction.

◆ print_parameters()

void libMesh::RBParametrized::print_parameters ( ) const

inherited

Print the current parameters.

◆ process_parameters_file()

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

overridevirtual

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

Reimplemented from libMesh::RBConstruction.

◆ process_temporal_parameters_file()

void libMesh::RBTemporalDiscretization::process_temporal_parameters_file ( const std::string & parameters_filename )

inherited

Read in and initialize parameters from parameters_filename.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns: The rank of this processor in the group.

Definition at line 101 of file parallel_object.h.

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

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

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

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ project_solution() [1/3]

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

inherited

Projects arbitrary functions onto the current solution.

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

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

◆ project_solution() [2/3]

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

inherited

Projects arbitrary functions onto the current solution.

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

◆ project_solution() [3/3]

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

inherited

◆ project_solution_on_reinit()

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

inherited

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

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

Definition at line 794 of file system.h.

References libMesh::System::_solution_projection.

795 { return _solution_projection; }

libMesh::System::_solution_projection

bool _solution_projection

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

Definition: system.h:1959

◆ project_vector() [1/5]

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

inherited

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

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

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

◆ project_vector() [2/5]

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

inherited

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

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

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

◆ project_vector() [3/5]

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

inherited

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

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

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

◆ project_vector() [4/5]

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

protectedinherited

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

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

◆ project_vector() [5/5]

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

protectedinherited

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

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

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

◆ projection_matrix()

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

inherited

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

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

◆ prolong_vectors()

virtual void libMesh::System::prolong_vectors ( )

virtualinherited

Prolong vectors after the mesh has refined.

◆ pull_temporal_discretization_data()

void libMesh::RBTemporalDiscretization::pull_temporal_discretization_data ( RBTemporalDiscretization & other )

inherited

Pull the temporal discretization data from other.

◆ qoi_parameter_hessian()

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

overridevirtualinherited

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

Note that in some cases only current_local_solution is used during assembly, and, therefore, if solution has been altered without update() being called, then the user must call update() before calling this function.

Reimplemented from libMesh::System.

◆ qoi_parameter_hessian_vector_product()

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

overridevirtualinherited

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

Reimplemented from libMesh::System.

◆ qoi_parameter_sensitivity()

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

virtualinherited

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

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

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

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

◆ re_update()

virtual void libMesh::TransientSystem< RBConstruction >::re_update ( )

overrideprotectedvirtualinherited

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

◆ read_header()

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

inherited

Reads the basic data header for this System.

◆ read_legacy_data()

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

inherited

Reads additional data, namely vectors, for this System.

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

◆ read_parallel_data() [1/2]

template<typename InValType >

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

inherited

Reads additional data, namely vectors, for this System.

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

◆ read_parallel_data() [2/2]

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

inherited

Non-templated version for backward compatibility.

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

Definition at line 1299 of file system.h.

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

◆ read_parameter_data_from_files()

void libMesh::RBParametrized::read_parameter_data_from_files	(	const std::string &	continuous_param_file_name,
		const std::string &	discrete_param_file_name,
		const bool	read_binary_data
	)

inherited

Read in the parameter ranges from files.

◆ read_riesz_representors_from_files()

virtual void libMesh::TransientRBConstruction::read_riesz_representors_from_files	(	const std::string &	riesz_representors_dir,
		const bool	write_binary_residual_representors
	)

overridevirtual

Write out all the Riesz representor data to files.

Override to read in transient data too.

Reimplemented from libMesh::RBConstruction.

◆ read_serialized_data() [1/2]

template<typename ValType >

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

inherited

Reads additional data, namely vectors, for this System.

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

◆ read_serialized_data() [2/2]

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

inherited

Non-templated version for backward compatibility.

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

Definition at line 1257 of file system.h.

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

◆ read_serialized_vectors() [1/2]

template<typename InValType >

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

inherited

Read a number of identically distributed vectors.

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

◆ read_serialized_vectors() [2/2]

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

inherited

Non-templated version for backward compatibility.

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

Definition at line 1277 of file system.h.

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

◆ recompute_all_residual_terms()

virtual void libMesh::RBConstruction::recompute_all_residual_terms ( const bool compute_inner_products = true )

virtualinherited

This function computes all of the residual representors, can be useful when restarting a basis training computation.

If compute_inner_products is false, we just compute the residual Riesz representors, whereas if true, we also compute all the corresponding inner product terms.

◆ reinit()

virtual void libMesh::LinearImplicitSystem::reinit ( )

overridevirtualinherited

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

Reimplemented from libMesh::ImplicitSystem.

Reimplemented in libMesh::NewmarkSystem.

◆ reinit_constraints()

virtual void libMesh::System::reinit_constraints ( )

virtualinherited

Reinitializes the constraints for this system.

◆ release_linear_solver()

virtual void libMesh::LinearImplicitSystem::release_linear_solver ( LinearSolver< Number > * ) const

overridevirtualinherited

Releases a pointer to a linear solver acquired by this->get_linear_solver()

Reimplemented from libMesh::ImplicitSystem.

◆ remove_matrix()

void libMesh::ImplicitSystem::remove_matrix ( const std::string & mat_name )

inherited

Removes the additional matrix mat_name from this system.

◆ remove_vector()

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

inherited

Removes the additional vector vec_name from this system.

◆ request_matrix() [1/2]

const SparseMatrix<Number>* libMesh::ImplicitSystem::request_matrix ( const std::string & mat_name ) const

inherited

Returns: A const pointer to this system's additional matrix named mat_name, or nullptr if no matrix by that name exists.

◆ request_matrix() [2/2]

SparseMatrix<Number>* libMesh::ImplicitSystem::request_matrix ( const std::string & mat_name )

inherited

Returns: A writable pointer to this system's additional matrix named mat_name, or nullptr if no matrix by that name exists.

◆ request_vector() [1/4]

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

inherited

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

◆ request_vector() [2/4]

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

inherited

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

◆ request_vector() [3/4]

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

inherited

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

◆ request_vector() [4/4]

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

inherited

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

◆ restrict_solve_to()

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

overridevirtualinherited

After calling this method, any solve will be limited to the given subset.

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

Reimplemented from libMesh::System.

◆ restrict_vectors()

virtual void libMesh::System::restrict_vectors ( )

virtualinherited

Restrict vectors after the mesh has coarsened.

◆ sensitivity_solve()

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

overridevirtualinherited

Assembles & solves the linear system(s) (dR/du)*u_p = -dR/dp, for those parameters contained within parameters.

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

Reimplemented from libMesh::System.

◆ set_abs_training_tolerance()

void libMesh::RBConstruction::set_abs_training_tolerance ( Real new_training_tolerance )

inherited

Get/set the absolute tolerance for the basis training.

Definition at line 191 of file rb_construction.h.

References libMesh::RBConstruction::abs_training_tolerance.

192 {this->abs_training_tolerance = new_training_tolerance; }

libMesh::RBConstruction::abs_training_tolerance

Real abs_training_tolerance

Definition: rb_construction.h:802

◆ set_adjoint_already_solved()

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

inherited

Setter for the adjoint_already_solved boolean.

Definition at line 394 of file system.h.

References libMesh::System::adjoint_already_solved.

395 { adjoint_already_solved = setting;}

libMesh::System::adjoint_already_solved

bool adjoint_already_solved

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

Definition: system.h:2003

◆ set_basic_system_only()

void libMesh::System::set_basic_system_only ( )

inherited

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

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

Definition at line 2097 of file system.h.

References libMesh::System::_basic_system_only.

 {
   _basic_system_only = true;
 }

◆ set_context_solution_vec()

virtual void libMesh::RBConstruction::set_context_solution_vec ( NumericVector< Number > & vec )

protectedvirtualinherited

Set current_local_solution = vec so that we can access vec from FEMContext during assembly.

Override in subclasses if different behavior is required.

◆ set_control()

void libMesh::RBTemporalDiscretization::set_control ( const std::vector< Real > & control )

inherited

◆ set_convergence_assertion_flag()

void libMesh::RBConstruction::set_convergence_assertion_flag ( bool flag )

inherited

Setter for the flag determining if convergence should be checked after each solve.

◆ set_delta_N()

void libMesh::TransientRBConstruction::set_delta_N ( const unsigned int new_delta_N )

Set delta_N, the number of basis functions we add to the RB space from each POD.

Definition at line 221 of file transient_rb_construction.h.

References libMesh::RBConstruction::delta_N.

221 { this->delta_N = new_delta_N; }

libMesh::RBConstruction::delta_N

unsigned int delta_N

The number of basis functions that we add at each greedy step.

Definition: rb_construction.h:733

◆ set_delta_t()

void libMesh::RBTemporalDiscretization::set_delta_t ( const Real delta_t_in )

inherited

◆ set_deterministic_training_parameter_name()

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

inherited

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

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

◆ set_deterministic_training_parameter_repeats()

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

inherited

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

◆ set_error_temporal_data()

Number libMesh::TransientRBConstruction::set_error_temporal_data ( )

protected

Set column k (i.e.

the current time level) of temporal_data to the difference between the current solution and the orthogonal projection of the current solution onto the current RB space.

◆ set_euler_theta()

void libMesh::RBTemporalDiscretization::set_euler_theta ( const Real euler_theta_in )

inherited

◆ set_inner_product_assembly()

void libMesh::RBConstruction::set_inner_product_assembly ( ElemAssembly & inner_product_assembly_in )

inherited

Set the rb_assembly_expansion object.

Referenced by SimpleRBConstruction::init_data().

◆ set_L2_assembly()

void libMesh::TransientRBConstruction::set_L2_assembly ( ElemAssembly & L2_assembly_in )

Set the L2 object.

◆ set_max_truth_solves()

void libMesh::TransientRBConstruction::set_max_truth_solves ( int max_truth_solves_in )

Definition at line 209 of file transient_rb_construction.h.

References max_truth_solves.

209 { this->max_truth_solves = max_truth_solves_in; }

libMesh::TransientRBConstruction::max_truth_solves

int max_truth_solves

Maximum number of truth solves in the POD-Greedy.

Definition: transient_rb_construction.h:388

◆ set_n_time_steps()

void libMesh::RBTemporalDiscretization::set_n_time_steps ( const unsigned int K )

inherited

◆ set_Nmax()

virtual void libMesh::RBConstruction::set_Nmax ( unsigned int Nmax )

virtualinherited

◆ set_normalize_rb_bound_in_greedy()

void libMesh::RBConstruction::set_normalize_rb_bound_in_greedy ( bool normalize_rb_bound_in_greedy_in )

inherited

Get/set the boolean to indicate if we normalize the RB error in the greedy.

Definition at line 198 of file rb_construction.h.

References libMesh::RBConstruction::normalize_rb_bound_in_greedy.

199 {this->normalize_rb_bound_in_greedy = normalize_rb_bound_in_greedy_in; }

libMesh::RBConstruction::normalize_rb_bound_in_greedy

bool normalize_rb_bound_in_greedy

This boolean indicates if we normalize the RB error in the greedy using RBEvaluation::get_error_bound...

Definition: rb_construction.h:808

◆ set_parameters()

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

inherited

Set the current parameters to params.

Referenced by SimpleRBEvaluation::get_stability_lower_bound().

◆ set_params_from_training_set()

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

protectedinherited

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

◆ set_params_from_training_set_and_broadcast()

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

protectedvirtualinherited

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

◆ set_POD_tol()

void libMesh::TransientRBConstruction::set_POD_tol ( const Real POD_tol_in )

Definition at line 215 of file transient_rb_construction.h.

References POD_tol.

215 { this->POD_tol = POD_tol_in; }

libMesh::TransientRBConstruction::POD_tol

Real POD_tol

If positive, this tolerance determines the number of POD modes we add to the space on a call to enric...

Definition: transient_rb_construction.h:380

◆ set_quiet_mode()

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

inherited

Set the quiet_mode flag.

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

Definition at line 92 of file rb_construction_base.h.

93 { this->quiet_mode = quiet_mode_in; }

libMesh::RBConstructionBase< LinearImplicitSystem >::quiet_mode

bool quiet_mode

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

Definition: rb_construction_base.h:239

◆ set_rb_assembly_expansion()

void libMesh::RBConstruction::set_rb_assembly_expansion ( RBAssemblyExpansion & rb_assembly_expansion_in )

inherited

Set the rb_assembly_expansion object.

Referenced by SimpleRBConstruction::init_data().

◆ set_rb_construction_parameters()

void libMesh::RBConstruction::set_rb_construction_parameters	(	unsigned int	n_training_samples_in,
		bool	deterministic_training_in,
		unsigned int	training_parameters_random_seed_in,
		bool	quiet_mode_in,
		unsigned int	Nmax_in,
		Real	rel_training_tolerance_in,
		Real	abs_training_tolerance_in,
		bool	normalize_rb_error_bound_in_greedy_in,
		RBParameters	mu_min_in,
		RBParameters	mu_max_in,
		std::map< std::string, std::vector< Real >>	discrete_parameter_values_in,
		std::map< std::string, bool >	log_scaling
	)

inherited

Set the state of this RBConstruction object based on the arguments to this function.

◆ set_rb_evaluation()

void libMesh::RBConstruction::set_rb_evaluation ( RBEvaluation & rb_eval_in )

inherited

Set the RBEvaluation object.

◆ set_rel_training_tolerance()

void libMesh::RBConstruction::set_rel_training_tolerance ( Real new_training_tolerance )

inherited

Get/set the relative tolerance for the basis training.

Definition at line 184 of file rb_construction.h.

References libMesh::RBConstruction::rel_training_tolerance.

185 {this->rel_training_tolerance = new_training_tolerance; }

libMesh::RBConstruction::rel_training_tolerance

Real rel_training_tolerance

Relative and absolute tolerances for training reduced basis using the Greedy scheme.

Definition: rb_construction.h:801

◆ set_time_step()

void libMesh::RBTemporalDiscretization::set_time_step ( const unsigned int k )

inherited

◆ set_training_random_seed()

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

inherited

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

◆ set_vector_as_adjoint()

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

inherited

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

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

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

◆ set_vector_preservation()

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

inherited

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

◆ solve()

virtual void libMesh::LinearImplicitSystem::solve ( )

overridevirtualinherited

Assembles & solves the linear system A*x=b.

Reimplemented from libMesh::ImplicitSystem.

Reimplemented in libMesh::FrequencySystem.

◆ solve_for_matrix_and_rhs()

virtual void libMesh::RBConstruction::solve_for_matrix_and_rhs	(	LinearSolver< Number > &	input_solver,
		SparseMatrix< Number > &	input_matrix,
		NumericVector< Number > &	input_rhs
	)

virtualinherited

Assembles & solves the linear system A*x=b for the specified matrix input_matrix and right-hand side rhs.

◆ system()

sys_type& libMesh::TransientSystem< RBConstruction >::system ( )

inherited

Returns: A reference to *this.

Definition at line 82 of file transient_system.h.

82 { return *this; }

◆ system_type()

std::string libMesh::TransientSystem< RBConstruction >::system_type ( ) const

overridevirtualinherited

Returns: "Transient" prepended to T::system_type(). Helps in identifying the system type in an equation system file.

Reimplemented from libMesh::RBConstruction.

Definition at line 166 of file transient_system.h.

 {
   std::string type = "Transient";
   type += Base::system_type ();
 
   return type;
 }

◆ train_reduced_basis()

virtual Real libMesh::TransientRBConstruction::train_reduced_basis ( const bool resize_rb_eval_data = true )

overridevirtual

Train the reduced basis.

Overridden so that we can set the flag compute_truth_projection_error to true so that the calls to truth_solve during the basis construction will compute the projection error. Other calls to truth_solve generally do not need to perform these projection calculations.

Reimplemented from libMesh::RBConstruction.

◆ truth_assembly()

virtual void libMesh::TransientRBConstruction::truth_assembly ( )

overridevirtual

Assemble the truth system in the transient linear case.

Reimplemented from libMesh::RBConstruction.

◆ truth_solve()

virtual Real libMesh::TransientRBConstruction::truth_solve ( int write_interval )

overridevirtual

Perform a truth solve at the current parameter.

Reimplemented from libMesh::RBConstruction.

◆ update()

virtual void libMesh::System::update ( )

virtualinherited

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

Reimplemented in SolidSystem.

◆ update_global_solution() [1/2]

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

inherited

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

Requires communication with all other processors.

◆ update_global_solution() [2/2]

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

inherited

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

Requires communication with all other processors.

◆ update_greedy_param_list()

void libMesh::RBConstruction::update_greedy_param_list ( )

protectedinherited

Update the list of Greedily chosen parameters with current_parameters.

◆ update_RB_initial_condition_all_N()

void libMesh::TransientRBConstruction::update_RB_initial_condition_all_N ( )

Compute the L2 projection of the initial condition onto the RB space for 1 <= N <= RB_size and store each projection in RB_initial_condition_matrix.

◆ update_RB_system_matrices()

virtual void libMesh::TransientRBConstruction::update_RB_system_matrices ( )

overrideprotectedvirtual

Compute the reduced basis matrices for the current basis.

Reimplemented from libMesh::RBConstruction.

◆ update_residual_terms()

virtual void libMesh::TransientRBConstruction::update_residual_terms ( bool compute_inner_products )

overrideprotectedvirtual

Compute the terms that are combined ‘online’ to determine the dual norm of the residual.

Reimplemented from libMesh::RBConstruction.

◆ update_system()

virtual void libMesh::TransientRBConstruction::update_system ( )

overrideprotectedvirtual

Update the system after enriching the RB space.

Reimplemented from libMesh::RBConstruction.

◆ user_assembly()

virtual void libMesh::System::user_assembly ( )

virtualinherited

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

◆ user_constrain()

virtual void libMesh::System::user_constrain ( )

virtualinherited

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

◆ user_initialization()

virtual void libMesh::System::user_initialization ( )

virtualinherited

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

◆ user_QOI()

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

virtualinherited

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

◆ user_QOI_derivative()

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

virtualinherited

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

◆ variable()

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

inherited

Return a constant reference to Variable var.

Definition at line 2133 of file system.h.

References libMesh::System::_variables.

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

◆ variable_group()

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

inherited

Return a constant reference to VariableGroup vg.

Definition at line 2143 of file system.h.

References libMesh::System::_variable_groups.

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

◆ variable_name()

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

inherited

Returns: The name of variable i.

Definition at line 2153 of file system.h.

References libMesh::System::_variables.

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

◆ variable_number()

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

inherited

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

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

◆ variable_scalar_number() [1/2]

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

inherited

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

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

Definition at line 2164 of file system.h.

References libMesh::System::variable_number().

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

◆ variable_scalar_number() [2/2]

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

inherited

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

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

Definition at line 2174 of file system.h.

References libMesh::System::_variables.

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

◆ variable_type() [1/2]

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

inherited

Returns: The finite element type variable number i.

Definition at line 2183 of file system.h.

References libMesh::System::_variables.

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

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

◆ variable_type() [2/2]

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

inherited

Returns: The finite element type for variable var.

Definition at line 2193 of file system.h.

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

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

◆ vector_is_adjoint()

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

inherited

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

◆ vector_name() [1/2]

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

inherited

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

◆ vector_name() [2/2]

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

inherited

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

◆ vector_preservation()

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

inherited

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

◆ vectors_begin() [1/2]

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

inherited

Beginning of vectors container.

Definition at line 2245 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.begin();
 }

◆ vectors_begin() [2/2]

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

inherited

Beginning of vectors container.

Definition at line 2251 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.begin();
 }

◆ vectors_end() [1/2]

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

inherited

End of vectors container.

Definition at line 2257 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.end();
 }

◆ vectors_end() [2/2]

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

inherited

End of vectors container.

Definition at line 2263 of file system.h.

References libMesh::System::_vectors.

 {
   return _vectors.end();
 }

◆ weighted_sensitivity_adjoint_solve()

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

overridevirtualinherited

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

Reimplemented from libMesh::System.

◆ weighted_sensitivity_solve()

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

overridevirtualinherited

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

Reimplemented from libMesh::System.

◆ write_header()

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

inherited

Writes the basic data header for this System.

◆ write_parallel_data()

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

inherited

Writes additional data, namely vectors, for this System.

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

◆ write_parameter_data_to_files()

void libMesh::RBParametrized::write_parameter_data_to_files	(	const std::string &	continuous_param_file_name,
		const std::string &	discrete_param_file_name,
		const bool	write_binary_data
	)

inherited

Write out the parameter ranges to files.

◆ write_riesz_representors_to_files()

virtual void libMesh::TransientRBConstruction::write_riesz_representors_to_files	(	const std::string &	riesz_representors_dir,
		const bool	write_binary_residual_representors
	)

overridevirtual

Write out all the Riesz representor data to files.

Override to write out transient data too.

Reimplemented from libMesh::RBConstruction.

◆ write_serialized_data()

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

inherited

Writes additional data, namely vectors, for this System.

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

◆ write_serialized_vectors()

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

inherited

Serialize & write a number of identically distributed vectors.

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

◆ zero_constrained_dofs_on_vector()

void libMesh::RBConstruction::zero_constrained_dofs_on_vector ( NumericVector< Number > & vector )

inherited

It is sometimes useful to be able to zero vector entries that correspond to constrained dofs.

◆ zero_variable()

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

inherited

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

Member Data Documentation

◆ _communicator

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

protectedinherited

Definition at line 107 of file parallel_object.h.

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

◆ _counts [1/2]

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _counts [2/2]

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _enable_print_counter [1/2]

bool libMesh::ReferenceCounter::_enable_print_counter

staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

◆ _enable_print_counter [2/2]

bool libMesh::ReferenceCounter::_enable_print_counter

staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

◆ _final_linear_residual

Real libMesh::LinearImplicitSystem::_final_linear_residual

protectedinherited

The final residual for the linear system Ax=b.

Definition at line 204 of file linear_implicit_system.h.

Referenced by libMesh::LinearImplicitSystem::final_linear_residual().

◆ _mutex [1/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _mutex [2/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_linear_iterations

unsigned int libMesh::LinearImplicitSystem::_n_linear_iterations

protectedinherited

The number of linear iterations required to solve the linear system Ax=b.

Definition at line 199 of file linear_implicit_system.h.

Referenced by libMesh::LinearImplicitSystem::n_linear_iterations().

◆ _n_objects [1/2]

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _n_objects [2/2]

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _shell_matrix

ShellMatrix<Number>* libMesh::LinearImplicitSystem::_shell_matrix

protectedinherited

User supplies shell matrix or nullptr if no shell matrix is used.

Definition at line 209 of file linear_implicit_system.h.

Referenced by libMesh::LinearImplicitSystem::get_shell_matrix().

◆ _subset

const SystemSubset* libMesh::LinearImplicitSystem::_subset

protectedinherited

The current subset on which to solve (or nullptr if none).

Definition at line 214 of file linear_implicit_system.h.

◆ _subset_solve_mode

SubsetSolveMode libMesh::LinearImplicitSystem::_subset_solve_mode

protectedinherited

If restrict-solve-to-subset mode is active, this member decides what happens with the dofs outside the subset.

Definition at line 220 of file linear_implicit_system.h.

◆ assemble_before_solve

bool libMesh::System::assemble_before_solve

inherited

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

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

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

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

Definition at line 1477 of file system.h.

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

◆ assert_convergence

bool libMesh::RBConstruction::assert_convergence

protectedinherited

A boolean flag to indicate whether to check for proper convergence after each solve.

Definition at line 746 of file rb_construction.h.

◆ compute_RB_inner_product

bool libMesh::RBConstruction::compute_RB_inner_product

inherited

Boolean flag to indicate whether we compute the RB_inner_product_matrix.

This is false by default in RBConstruction since (in the default implementation) the RB inner-product matrix will just be the identity. But we may need the inner-product matrix subclasses.

Definition at line 539 of file rb_construction.h.

◆ compute_truth_projection_error

bool libMesh::TransientRBConstruction::compute_truth_projection_error

Boolean flag that indicates whether we will compute the projection error for the truth solution into the RB space (at every time level).

This typically only needs to true during a call to train_reduced_basis.

Definition at line 301 of file transient_rb_construction.h.

◆ current_local_solution

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

inherited

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

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

Definition at line 1535 of file system.h.

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

◆ delta_N

unsigned int libMesh::RBConstruction::delta_N

protectedinherited

The number of basis functions that we add at each greedy step.

This defaults to 1 in the steady case.

Definition at line 733 of file rb_construction.h.

Referenced by libMesh::RBConstruction::get_delta_N(), and set_delta_N().

◆ exit_on_repeated_greedy_parameters

bool libMesh::RBConstruction::exit_on_repeated_greedy_parameters

inherited

Boolean flag to indicate whether we exit the greedy if we select the same parameters twice in a row.

In some problems this indicates that the greedy has "saturated" typically due to numerical rounding effects.

Definition at line 516 of file rb_construction.h.

◆ extra_linear_solver

LinearSolver<Number>* libMesh::RBConstruction::extra_linear_solver

inherited

Also, we store a pointer to an extra linear solver.

This can be useful if we want to pass in the linear solver from somewhere else. For example, if a solver is already primed elsewhere then it can be more efficient to use that solver.

Definition at line 465 of file rb_construction.h.

◆ extra_quadrature_order

int libMesh::System::extra_quadrature_order

inherited

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

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

Definition at line 1508 of file system.h.

◆ Fq_representor

std::vector<std::unique_ptr<NumericVector<Number> > > libMesh::RBConstruction::Fq_representor

inherited

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

These are basis independent and hence stored here, whereas the Aq_representors are stored in RBEvaluation

Definition at line 490 of file rb_construction.h.

◆ Fq_representor_innerprods

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

inherited

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

We store the Fq representor norms here because they are independent of a reduced basis space. The basis dependent representors are stored in RBEvaluation.

Definition at line 499 of file rb_construction.h.

◆ Fq_representor_innerprods_computed

bool libMesh::RBConstruction::Fq_representor_innerprods_computed

inherited

A boolean flag to indicate whether or not the Fq representor norms have already been computed — used to make sure that we don't recompute them unnecessarily.

Definition at line 560 of file rb_construction.h.

◆ impose_internal_fluxes

bool libMesh::RBConstruction::impose_internal_fluxes

inherited

Boolean flag to indicate whether we impose "fluxes" (i.e.

element boundary contributions to the weak form) on internal element boundaries in the assembly routines.

Definition at line 523 of file rb_construction.h.

◆ init_filename

std::string libMesh::TransientRBConstruction::init_filename

The filename of the file containing the initial condition projected onto the truth mesh.

Definition at line 307 of file transient_rb_construction.h.

◆ inner_product_matrix

std::unique_ptr<SparseMatrix<Number> > libMesh::RBConstruction::inner_product_matrix

inherited

The inner product matrix.

Definition at line 470 of file rb_construction.h.

◆ inner_product_solver

std::unique_ptr<LinearSolver<Number> > libMesh::RBConstruction::inner_product_solver

inherited

We store an extra linear solver object which we can optionally use for solving all systems in which the system matrix is set to inner_product_matrix.

Definition at line 457 of file rb_construction.h.

◆ inner_product_storage_vector

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

protectedinherited

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

Definition at line 254 of file rb_construction_base.h.

◆ L2_assembly

ElemAssembly* libMesh::TransientRBConstruction::L2_assembly

protected

Function pointer for assembling the L2 matrix.

Definition at line 393 of file transient_rb_construction.h.

◆ L2_matrix

std::unique_ptr<SparseMatrix<Number> > libMesh::TransientRBConstruction::L2_matrix

The L2 matrix.

Definition at line 264 of file transient_rb_construction.h.

◆ linear_solver

std::unique_ptr<LinearSolver<Number> > libMesh::LinearImplicitSystem::linear_solver

inherited

The LinearSolver defines the interface used to solve the linear_implicit system.

This class handles all the details of interfacing with various linear algebra packages like PETSc or LASPACK.

Definition at line 158 of file linear_implicit_system.h.

◆ M_q_vector

std::vector<std::unique_ptr<SparseMatrix<Number> > > libMesh::TransientRBConstruction::M_q_vector

Vector storing the Q_m matrices from the mass operator.

Definition at line 275 of file transient_rb_construction.h.

◆ matrix

SparseMatrix<Number>* libMesh::ImplicitSystem::matrix

inherited

The system matrix.

Implicit systems are characterized by the need to solve the linear system Ax=b. This is the system matrix A.

Definition at line 373 of file implicit_system.h.

◆ max_truth_solves

int libMesh::TransientRBConstruction::max_truth_solves

protected

Maximum number of truth solves in the POD-Greedy.

This can be different from Nmax in the transient case since we may add more than one basis function per truth solve. If negative, it's ignored.

Definition at line 388 of file transient_rb_construction.h.

Referenced by get_max_truth_solves(), and set_max_truth_solves().

◆ Nmax

unsigned int libMesh::RBConstruction::Nmax

protectedinherited

Maximum number of reduced basis functions we are willing to use.

Definition at line 727 of file rb_construction.h.

Referenced by libMesh::RBConstruction::get_Nmax().

◆ non_dirichlet_L2_matrix

std::unique_ptr<SparseMatrix<Number> > libMesh::TransientRBConstruction::non_dirichlet_L2_matrix

The L2 matrix without Dirichlet conditions enforced.

(This is only computed if store_non_dirichlet_operators == true.)

Definition at line 270 of file transient_rb_construction.h.

◆ non_dirichlet_M_q_vector

std::vector<std::unique_ptr<SparseMatrix<Number> > > libMesh::TransientRBConstruction::non_dirichlet_M_q_vector

We sometimes also need a second set of M_q matrices that do not have the Dirichlet boundary conditions enforced.

Definition at line 282 of file transient_rb_construction.h.

◆ nonzero_initialization

bool libMesh::TransientRBConstruction::nonzero_initialization

Boolean flag to indicate whether we are using a non-zero initialization.

If we are, then an initialization function must be attached to the system.

Definition at line 294 of file transient_rb_construction.h.

◆ old_local_solution

std::unique_ptr<NumericVector<Number> > libMesh::TransientSystem< RBConstruction >::old_local_solution

inherited

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

Think of this as the current solution with any ghost values needed from other processors.

Definition at line 119 of file transient_system.h.

◆ older_local_solution

std::unique_ptr<NumericVector<Number> > libMesh::TransientSystem< RBConstruction >::older_local_solution

inherited

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

Think of this as the current solution with any ghost values needed from other processors.

Definition at line 127 of file transient_system.h.

◆ output_dual_innerprods

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

inherited

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

Definition at line 482 of file rb_construction.h.

◆ output_dual_innerprods_computed

bool libMesh::RBConstruction::output_dual_innerprods_computed

protectedinherited

A boolean flag to indicate whether or not the output dual norms have already been computed — used to make sure that we don't recompute them unnecessarily.

Definition at line 740 of file rb_construction.h.

◆ POD_tol

Real libMesh::TransientRBConstruction::POD_tol

protected

If positive, this tolerance determines the number of POD modes we add to the space on a call to enrich_RB_space().

If negative, we add delta_N POD modes.

Definition at line 380 of file transient_rb_construction.h.

Referenced by get_POD_tol(), and set_POD_tol().

◆ qoi

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

inherited

Values of the quantities of interest.

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

Definition at line 1558 of file system.h.

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

◆ quiet_mode

bool libMesh::RBConstructionBase< LinearImplicitSystem >::quiet_mode

protectedinherited

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

Definition at line 239 of file rb_construction_base.h.

◆ RB_ic_proj_rhs_all_N

DenseVector<Number> libMesh::TransientRBConstruction::RB_ic_proj_rhs_all_N

protected

The vector that stores the right-hand side for the initial condition projections.

Definition at line 399 of file transient_rb_construction.h.

◆ rhs

NumericVector<Number>* libMesh::ExplicitSystem::rhs

inherited

The system matrix.

Implicit systems are characterized by the need to solve the linear system Ax=b. This is the right-hand-side vector b.

Definition at line 114 of file explicit_system.h.

◆ serial_training_set

bool libMesh::RBConstructionBase< LinearImplicitSystem >::serial_training_set

protectedinherited

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

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

Definition at line 247 of file rb_construction_base.h.

◆ skip_degenerate_sides

bool libMesh::RBConstruction::skip_degenerate_sides

inherited

In some cases meshes are intentionally created with degenerate sides as a way to represent, say, triangles using a hex-only mesh.

In this situation we should detect and skip any degenerate sides in order to prevent zero or negative element Jacobian errors.

Definition at line 531 of file rb_construction.h.

◆ skip_residual_in_train_reduced_basis

bool libMesh::RBConstruction::skip_residual_in_train_reduced_basis

inherited

Boolean flag to indicate if we skip residual calculations in train_reduced_basis.

This should only be used in special cases, e.g. when we know a priori that we want exactly one basis function and hence we do not need the residual based error indicator.

Definition at line 508 of file rb_construction.h.

◆ solution

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

inherited

Data structure to hold solution values.

Definition at line 1523 of file system.h.

◆ store_non_dirichlet_operators

bool libMesh::RBConstruction::store_non_dirichlet_operators

inherited

Boolean flag to indicate whether we store a second copy of each affine operator and vector which does not have Dirichlet bcs enforced.

Definition at line 546 of file rb_construction.h.

◆ temporal_data

std::vector<std::unique_ptr<NumericVector<Number> > > libMesh::TransientRBConstruction::temporal_data

private

Dense matrix to store the data that we use for the temporal POD.

Definition at line 408 of file transient_rb_construction.h.

◆ time

Real libMesh::System::time

inherited

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

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

Definition at line 1545 of file system.h.

◆ training_error_bounds

std::vector<Real> libMesh::RBConstruction::training_error_bounds

inherited

Vector storing the values of the error bound for each parameter in the training set — the parameter giving the largest error bound is chosen for the next snapshot in the Greedy basis training.

Definition at line 450 of file rb_construction.h.

◆ truth_outputs

std::vector<Number > libMesh::RBConstruction::truth_outputs

inherited

Vector storing the truth output values from the most recent truth solve.

Definition at line 476 of file rb_construction.h.

◆ truth_outputs_all_k

std::vector<std::vector<Number> > libMesh::TransientRBConstruction::truth_outputs_all_k

The truth outputs for all time-levels from the most recent truth_solve.

Definition at line 288 of file transient_rb_construction.h.

◆ use_empty_rb_solve_in_greedy

bool libMesh::RBConstruction::use_empty_rb_solve_in_greedy

inherited

A boolean flag to indicate whether or not we initialize the Greedy algorithm by performing rb_solves on the training set with an "empty" (i.e.

N=0) reduced basis space.

Definition at line 553 of file rb_construction.h.

◆ use_fixed_solution

bool libMesh::System::use_fixed_solution

inherited

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

stabilized methods. False by default.

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

Definition at line 1493 of file system.h.

◆ verbose_mode

bool libMesh::RBParametrized::verbose_mode

inherited

Public boolean to toggle verbose mode.

Definition at line 170 of file rb_parametrized.h.

◆ zero_out_matrix_and_rhs

bool libMesh::ImplicitSystem::zero_out_matrix_and_rhs

inherited

By default, the system will zero out the matrix and the right hand side.

If this flag is false, it is the responsibility of the client code to take care of setting these to zero before assembly begins

Definition at line 380 of file implicit_system.h.

The documentation for this class was generated from the following file:

include/reduced_basis/transient_rb_construction.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_matrices_iterator

◆ const_vectors_iterator

◆ Counts [1/2]

◆ Counts [2/2]

◆ GradientFunctionPointer

◆ matrices_iterator

◆ Parent

◆ sys_type

◆ ValueFunctionPointer

◆ vectors_iterator

Constructor & Destructor Documentation

◆ TransientRBConstruction()

◆ ~TransientRBConstruction()

Member Function Documentation

◆ activate()

◆ active()

◆ add_adjoint_rhs()

◆ add_adjoint_solution()

◆ add_IC_to_RB_space()

◆ add_matrix()

◆ add_scaled_Aq()

◆ add_scaled_mass_matrix()

◆ add_scaled_matrix_and_vector()

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

◆ allocate_data_structures()

◆ assemble()

◆ assemble_affine_expansion()

◆ assemble_all_affine_operators()

◆ assemble_all_affine_vectors()

◆ assemble_all_output_vectors()

◆ assemble_Aq_matrix()

◆ assemble_Fq_vector()

◆ assemble_inner_product_matrix()

◆ assemble_L2_matrix()

◆ assemble_mass_matrix()

◆ assemble_misc_matrices()

◆ assemble_Mq_matrix()

◆ assemble_qoi()

◆ assemble_qoi_derivative()

◆ assemble_residual_derivatives()

◆ assembly()

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

◆ attach_shell_matrix()

◆ boundary_project_solution() [1/2]

◆ boundary_project_solution() [2/2]

◆ boundary_project_vector() [1/2]

◆ boundary_project_vector() [2/2]

◆ broadcast_parameters()

◆ build_context()