Inheritance diagram for PMLHelmholtzMGProblem< ELEMENT >:

Public Member Functions
	PMLHelmholtzMGProblem ()
	Constructor. More...

	~PMLHelmholtzMGProblem ()
	Destructor (empty) More...

void	actions_before_newton_solve ()
	Update the problem specs before solve (empty) More...

void	actions_after_newton_solve ()
	Update the problem specs after solve (empty) More...

void	doc_solution ()
	Doc the solution: doc_info contains labels/output directory etc. More...

void	create_pml_meshes ()
	Create PML meshes. More...

void	apply_boundary_conditions ()
	Apply boundary conditions. More...

void	actions_before_adapt ()
	Actions before adapt: Wipe the PML meshes. More...

void	actions_after_adapt ()
	Actions after adapt: Rebuild the PML meshes. More...

void	set_gmres_multigrid_solver ()
	Set GMRES preconditioner by multigrid as the linear solver. More...

Public Member Functions inherited from oomph::HelmholtzMGProblem
	HelmholtzMGProblem ()
	Constructor. Initialise pointers to coarser and finer levels. More...

virtual	~HelmholtzMGProblem ()
	Destructor (empty) More...

Public Member Functions inherited from oomph::Problem
virtual void	debug_hook_fct (const unsigned &i)

void	set_analytic_dparameter (double *const &parameter_pt)

void	unset_analytic_dparameter (double *const &parameter_pt)

bool	is_dparameter_calculated_analytically (double *const &parameter_pt)

void	set_analytic_hessian_products ()

void	unset_analytic_hessian_products ()

bool	are_hessian_products_calculated_analytically ()

void	set_pinned_values_to_zero ()

bool	distributed () const

OomphCommunicator *	communicator_pt ()
	access function to the oomph-lib communicator More...

const OomphCommunicator *	communicator_pt () const
	access function to the oomph-lib communicator, const version More...

	Problem ()

	Problem (const Problem &dummy)=delete
	Broken copy constructor. More...

void	operator= (const Problem &)=delete
	Broken assignment operator. More...

virtual	~Problem ()
	Virtual destructor to clean up memory. More...

Mesh *&	mesh_pt ()
	Return a pointer to the global mesh. More...

Mesh *const &	mesh_pt () const
	Return a pointer to the global mesh (const version) More...

Mesh *&	mesh_pt (const unsigned &imesh)

Mesh *const &	mesh_pt (const unsigned &imesh) const
	Return a pointer to the i-th submesh (const version) More...

unsigned	nsub_mesh () const
	Return number of submeshes. More...

unsigned	add_sub_mesh (Mesh *const &mesh_pt)

void	flush_sub_meshes ()

void	build_global_mesh ()

void	rebuild_global_mesh ()

LinearSolver *&	linear_solver_pt ()
	Return a pointer to the linear solver object. More...

LinearSolver *const &	linear_solver_pt () const
	Return a pointer to the linear solver object (const version) More...

LinearSolver *&	mass_matrix_solver_for_explicit_timestepper_pt ()

LinearSolver *	mass_matrix_solver_for_explicit_timestepper_pt () const

EigenSolver *&	eigen_solver_pt ()
	Return a pointer to the eigen solver object. More...

EigenSolver *const &	eigen_solver_pt () const
	Return a pointer to the eigen solver object (const version) More...

Time *&	time_pt ()
	Return a pointer to the global time object. More...

Time *	time_pt () const
	Return a pointer to the global time object (const version). More...

double &	time ()
	Return the current value of continuous time. More...

double	time () const
	Return the current value of continuous time (const version) More...

TimeStepper *&	time_stepper_pt ()

const TimeStepper *	time_stepper_pt () const

TimeStepper *&	time_stepper_pt (const unsigned &i)
	Return a pointer to the i-th timestepper. More...

ExplicitTimeStepper *&	explicit_time_stepper_pt ()
	Return a pointer to the explicit timestepper. More...

unsigned long	set_timestepper_for_all_data (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data=false)

virtual void	shift_time_values ()
	Shift all values along to prepare for next timestep. More...

AssemblyHandler *&	assembly_handler_pt ()
	Return a pointer to the assembly handler object. More...

AssemblyHandler *const &	assembly_handler_pt () const
	Return a pointer to the assembly handler object (const version) More...

double &	minimum_dt ()
	Access function to min timestep in adaptive timestepping. More...

double &	maximum_dt ()
	Access function to max timestep in adaptive timestepping. More...

unsigned &	max_newton_iterations ()
	Access function to max Newton iterations before giving up. More...

void	problem_is_nonlinear (const bool &prob_lin)
	Access function to Problem_is_nonlinear. More...

double &	max_residuals ()

bool &	time_adaptive_newton_crash_on_solve_fail ()
	Access function for Time_adaptive_newton_crash_on_solve_fail. More...

double &	newton_solver_tolerance ()

void	add_time_stepper_pt (TimeStepper *const &time_stepper_pt)

void	set_explicit_time_stepper_pt (ExplicitTimeStepper *const &explicit_time_stepper_pt)

void	initialise_dt (const double &dt)

void	initialise_dt (const Vector< double > &dt)

Data *&	global_data_pt (const unsigned &i)
	Return a pointer to the the i-th global data object. More...

void	add_global_data (Data *const &global_data_pt)

void	flush_global_data ()

LinearAlgebraDistribution *const &	dof_distribution_pt () const
	Return the pointer to the dof distribution (read-only) More...

unsigned long	ndof () const
	Return the number of dofs. More...

unsigned	ntime_stepper () const
	Return the number of time steppers. More...

unsigned	nglobal_data () const
	Return the number of global data values. More...

unsigned	self_test ()
	Self-test: Check meshes and global data. Return 0 for OK. More...

void	enable_store_local_dof_pt_in_elements ()

void	disable_store_local_dof_pt_in_elements ()

unsigned long	assign_eqn_numbers (const bool &assign_local_eqn_numbers=true)

void	describe_dofs (std::ostream &out= *(oomph_info.stream_pt())) const

void	enable_discontinuous_formulation ()

void	disable_discontinuous_formulation ()

void	get_dofs (DoubleVector &dofs) const

void	get_dofs (const unsigned &t, DoubleVector &dofs) const
	Return vector of the t'th history value of all dofs. More...

void	set_dofs (const DoubleVector &dofs)
	Set the values of the dofs. More...

void	set_dofs (const unsigned &t, DoubleVector &dofs)
	Set the history values of the dofs. More...

void	set_dofs (const unsigned &t, Vector< double * > &dof_pt)

void	add_to_dofs (const double &lambda, const DoubleVector &increment_dofs)
	Add lambda x incremenet_dofs[l] to the l-th dof. More...

double *	global_dof_pt (const unsigned &i)

double &	dof (const unsigned &i)
	i-th dof in the problem More...

double	dof (const unsigned &i) const
	i-th dof in the problem (const version) More...

double *&	dof_pt (const unsigned &i)
	Pointer to i-th dof in the problem. More...

double *	dof_pt (const unsigned &i) const
	Pointer to i-th dof in the problem (const version) More...

virtual void	get_inverse_mass_matrix_times_residuals (DoubleVector &Mres)

virtual void	get_dvaluesdt (DoubleVector &f)

virtual void	get_residuals (DoubleVector &residuals)
	Get the total residuals Vector for the problem. More...

virtual void	get_jacobian (DoubleVector &residuals, DenseDoubleMatrix &jacobian)

virtual void	get_jacobian (DoubleVector &residuals, CRDoubleMatrix &jacobian)

virtual void	get_jacobian (DoubleVector &residuals, CCDoubleMatrix &jacobian)

virtual void	get_jacobian (DoubleVector &residuals, SumOfMatrices &jacobian)

void	get_fd_jacobian (DoubleVector &residuals, DenseMatrix< double > &jacobian)
	Get the full Jacobian by finite differencing. More...

void	get_derivative_wrt_global_parameter (double *const &parameter_pt, DoubleVector &result)

void	get_hessian_vector_products (DoubleVectorWithHaloEntries const &Y, Vector< DoubleVectorWithHaloEntries > const &C, Vector< DoubleVectorWithHaloEntries > &product)

void	solve_eigenproblem (const unsigned &n_eval, Vector< std::complex< double >> &eigenvalue, Vector< DoubleVector > &eigenvector, const bool &steady=true)
	Solve the eigenproblem. More...

void	solve_eigenproblem (const unsigned &n_eval, Vector< std::complex< double >> &eigenvalue, const bool &steady=true)

virtual void	get_eigenproblem_matrices (CRDoubleMatrix &mass_matrix, CRDoubleMatrix &main_matrix, const double &shift=0.0)

void	assign_eigenvector_to_dofs (DoubleVector &eigenvector)
	Assign the eigenvector passed to the function to the dofs. More...

void	add_eigenvector_to_dofs (const double &epsilon, const DoubleVector &eigenvector)

void	store_current_dof_values ()
	Store the current values of the degrees of freedom. More...

void	restore_dof_values ()
	Restore the stored values of the degrees of freedom. More...

void	enable_jacobian_reuse ()

void	disable_jacobian_reuse ()
	Disable recycling of Jacobian in Newton iteration. More...

bool	jacobian_reuse_is_enabled ()
	Is recycling of Jacobian in Newton iteration enabled? More...

bool &	use_predictor_values_as_initial_guess ()

void	newton_solve ()
	Use Newton method to solve the problem. More...

void	enable_globally_convergent_newton_method ()
	enable globally convergent Newton method More...

void	disable_globally_convergent_newton_method ()
	disable globally convergent Newton method More...

void	newton_solve (unsigned const &max_adapt)

void	steady_newton_solve (unsigned const &max_adapt=0)

void	copy (Problem *orig_problem_pt)

virtual Problem *	make_copy ()

virtual void	read (std::ifstream &restart_file, bool &unsteady_restart)

virtual void	read (std::ifstream &restart_file)

virtual void	dump (std::ofstream &dump_file) const

void	dump (const std::string &dump_file_name) const

void	delete_all_external_storage ()

virtual void	symmetrise_eigenfunction_for_adaptive_pitchfork_tracking ()

double *	bifurcation_parameter_pt () const

void	get_bifurcation_eigenfunction (Vector< DoubleVector > &eigenfunction)

void	activate_fold_tracking (double *const &parameter_pt, const bool &block_solve=true)

void	activate_bifurcation_tracking (double *const &parameter_pt, const DoubleVector &eigenvector, const bool &block_solve=true)

void	activate_bifurcation_tracking (double *const &parameter_pt, const DoubleVector &eigenvector, const DoubleVector &normalisation, const bool &block_solve=true)

void	activate_pitchfork_tracking (double *const &parameter_pt, const DoubleVector &symmetry_vector, const bool &block_solve=true)

void	activate_hopf_tracking (double *const &parameter_pt, const bool &block_solve=true)

void	activate_hopf_tracking (double *const &parameter_pt, const double &omega, const DoubleVector &null_real, const DoubleVector &null_imag, const bool &block_solve=true)

void	deactivate_bifurcation_tracking ()

void	reset_assembly_handler_to_default ()
	Reset the system to the standard non-augemented state. More...

double	arc_length_step_solve (double *const &parameter_pt, const double &ds, const unsigned &max_adapt=0)

double	arc_length_step_solve (Data *const &data_pt, const unsigned &data_index, const double &ds, const unsigned &max_adapt=0)

void	reset_arc_length_parameters ()

int &	sign_of_jacobian ()

void	explicit_timestep (const double &dt, const bool &shift_values=true)
	Take an explicit timestep of size dt. More...

void	unsteady_newton_solve (const double &dt)

void	unsteady_newton_solve (const double &dt, const bool &shift_values)

void	unsteady_newton_solve (const double &dt, const unsigned &max_adapt, const bool &first, const bool &shift=true)

double	doubly_adaptive_unsteady_newton_solve (const double &dt, const double &epsilon, const unsigned &max_adapt, const bool &first, const bool &shift=true)

double	doubly_adaptive_unsteady_newton_solve (const double &dt, const double &epsilon, const unsigned &max_adapt, const unsigned &suppress_resolve_after_spatial_adapt_flag, const bool &first, const bool &shift=true)

double	adaptive_unsteady_newton_solve (const double &dt_desired, const double &epsilon)

double	adaptive_unsteady_newton_solve (const double &dt_desired, const double &epsilon, const bool &shift_values)

void	assign_initial_values_impulsive ()

void	assign_initial_values_impulsive (const double &dt)

void	calculate_predictions ()
	Calculate predictions. More...

void	enable_mass_matrix_reuse ()

void	disable_mass_matrix_reuse ()

bool	mass_matrix_reuse_is_enabled ()
	Return whether the mass matrix is being reused. More...

void	refine_uniformly (const Vector< unsigned > &nrefine_for_mesh)

void	refine_uniformly (const Vector< unsigned > &nrefine_for_mesh, DocInfo &doc_info)

void	refine_uniformly_and_prune (const Vector< unsigned > &nrefine_for_mesh)

void	refine_uniformly_and_prune (const Vector< unsigned > &nrefine_for_mesh, DocInfo &doc_info)

void	refine_uniformly (DocInfo &doc_info)

void	refine_uniformly_and_prune (DocInfo &doc_info)

void	refine_uniformly ()

void	refine_uniformly (const unsigned &i_mesh, DocInfo &doc_info)
	Do uniform refinement for submesh i_mesh with documentation. More...

void	refine_uniformly (const unsigned &i_mesh)
	Do uniform refinement for submesh i_mesh without documentation. More...

void	p_refine_uniformly (const Vector< unsigned > &nrefine_for_mesh)

void	p_refine_uniformly (const Vector< unsigned > &nrefine_for_mesh, DocInfo &doc_info)

void	p_refine_uniformly_and_prune (const Vector< unsigned > &nrefine_for_mesh)

void	p_refine_uniformly_and_prune (const Vector< unsigned > &nrefine_for_mesh, DocInfo &doc_info)

void	p_refine_uniformly (DocInfo &doc_info)

void	p_refine_uniformly_and_prune (DocInfo &doc_info)

void	p_refine_uniformly ()

void	p_refine_uniformly (const unsigned &i_mesh, DocInfo &doc_info)
	Do uniform p-refinement for submesh i_mesh with documentation. More...

void	p_refine_uniformly (const unsigned &i_mesh)
	Do uniform p-refinement for submesh i_mesh without documentation. More...

void	refine_selected_elements (const Vector< unsigned > &elements_to_be_refined)

void	refine_selected_elements (const Vector< RefineableElement * > &elements_to_be_refined_pt)

void	refine_selected_elements (const unsigned &i_mesh, const Vector< unsigned > &elements_to_be_refined)

void	refine_selected_elements (const unsigned &i_mesh, const Vector< RefineableElement * > &elements_to_be_refined_pt)

void	refine_selected_elements (const Vector< Vector< unsigned >> &elements_to_be_refined)

void	refine_selected_elements (const Vector< Vector< RefineableElement * >> &elements_to_be_refined_pt)

void	p_refine_selected_elements (const Vector< unsigned > &elements_to_be_refined)

void	p_refine_selected_elements (const Vector< PRefineableElement * > &elements_to_be_refined_pt)

void	p_refine_selected_elements (const unsigned &i_mesh, const Vector< unsigned > &elements_to_be_refined)

void	p_refine_selected_elements (const unsigned &i_mesh, const Vector< PRefineableElement * > &elements_to_be_refined_pt)

void	p_refine_selected_elements (const Vector< Vector< unsigned >> &elements_to_be_refined)

void	p_refine_selected_elements (const Vector< Vector< PRefineableElement * >> &elements_to_be_refined_pt)

unsigned	unrefine_uniformly ()

unsigned	unrefine_uniformly (const unsigned &i_mesh)

void	p_unrefine_uniformly (DocInfo &doc_info)

void	p_unrefine_uniformly (const unsigned &i_mesh, DocInfo &doc_info)
	Do uniform p-unrefinement for submesh i_mesh without documentation. More...

void	adapt (unsigned &n_refined, unsigned &n_unrefined)

void	adapt ()

void	p_adapt (unsigned &n_refined, unsigned &n_unrefined)

void	p_adapt ()

void	adapt_based_on_error_estimates (unsigned &n_refined, unsigned &n_unrefined, Vector< Vector< double >> &elemental_error)

void	adapt_based_on_error_estimates (Vector< Vector< double >> &elemental_error)

void	get_all_error_estimates (Vector< Vector< double >> &elemental_error)

void	doc_errors (DocInfo &doc_info)
	Get max and min error for all elements in submeshes. More...

void	doc_errors ()
	Get max and min error for all elements in submeshes. More...

void	enable_info_in_newton_solve ()

void	disable_info_in_newton_solve ()
	Disable the output of information when in the newton solver. More...

Public Member Functions inherited from oomph::ExplicitTimeSteppableObject
	ExplicitTimeSteppableObject ()
	Empty constructor. More...

	ExplicitTimeSteppableObject (const ExplicitTimeSteppableObject &)=delete
	Broken copy constructor. More...

void	operator= (const ExplicitTimeSteppableObject &)=delete
	Broken assignment operator. More...

virtual	~ExplicitTimeSteppableObject ()
	Empty destructor. More...

virtual void	actions_before_explicit_stage ()

virtual void	actions_after_explicit_stage ()

Private Member Functions
HelmholtzMGProblem *	make_new_problem ()
	Overload the make_new_problem function to return an object of this class. More...

TreeBasedRefineableMeshBase *	mg_bulk_mesh_pt ()

Private Attributes
RefineableQuadFromTriangleMesh< ELEMENT > *	Bulk_mesh_pt
	Pointer to the refineable "bulk" mesh. More...

Mesh *	PML_right_mesh_pt
	Pointer to the right PML mesh. More...

Mesh *	PML_top_mesh_pt
	Pointer to the top PML mesh. More...

Mesh *	PML_left_mesh_pt
	Pointer to the left PML mesh. More...

Mesh *	PML_bottom_mesh_pt
	Pointer to the bottom PML mesh. More...

Mesh *	PML_top_right_mesh_pt
	Pointer to the top right corner PML mesh. More...

Mesh *	PML_top_left_mesh_pt
	Pointer to the top left corner PML mesh. More...

Mesh *	PML_bottom_right_mesh_pt
	Pointer to the bottom right corner PML mesh. More...

Mesh *	PML_bottom_left_mesh_pt
	Pointer to the bottom left corner PML mesh. More...

ofstream	Trace_file
	Trace file. More...

Additional Inherited Members
Public Types inherited from oomph::Problem
typedef void(*	SpatialErrorEstimatorFctPt) (Mesh *&mesh_pt, Vector< double > &elemental_error)
	Function pointer for spatial error estimator. More...

typedef void(*	SpatialErrorEstimatorWithDocFctPt) (Mesh *&mesh_pt, Vector< double > &elemental_error, DocInfo &doc_info)
	Function pointer for spatial error estimator with doc. More...

Public Attributes inherited from oomph::Problem
bool	Shut_up_in_newton_solve

Static Public Attributes inherited from oomph::Problem
static bool	Suppress_warning_about_actions_before_read_unstructured_meshes

Protected Types inherited from oomph::Problem
enum	Assembly_method { Perform_assembly_using_vectors_of_pairs , Perform_assembly_using_two_vectors , Perform_assembly_using_maps , Perform_assembly_using_lists , Perform_assembly_using_two_arrays }
	Enumerated flags to determine which sparse assembly method is used. More...

Protected Member Functions inherited from oomph::Problem
unsigned	setup_element_count_per_dof ()

virtual void	sparse_assemble_row_or_column_compressed (Vector< int * > &column_or_row_index, Vector< int * > &row_or_column_start, Vector< double * > &value, Vector< unsigned > &nnz, Vector< double * > &residual, bool compressed_row_flag)

virtual void	actions_before_newton_convergence_check ()

virtual void	actions_before_newton_step ()

virtual void	actions_after_newton_step ()

virtual void	actions_before_implicit_timestep ()

virtual void	actions_after_implicit_timestep ()

virtual void	actions_after_implicit_timestep_and_error_estimation ()

virtual void	actions_before_explicit_timestep ()
	Actions that should be performed before each explicit time step. More...

virtual void	actions_after_explicit_timestep ()
	Actions that should be performed after each explicit time step. More...

virtual void	actions_before_read_unstructured_meshes ()

virtual void	actions_after_read_unstructured_meshes ()

virtual void	actions_after_change_in_global_parameter (double *const &parameter_pt)

virtual void	actions_after_change_in_bifurcation_parameter ()

virtual void	actions_after_parameter_increase (double *const &parameter_pt)

double &	dof_derivative (const unsigned &i)

double &	dof_current (const unsigned &i)

virtual void	set_initial_condition ()

virtual double	global_temporal_error_norm ()

unsigned	newton_solve_continuation (double *const &parameter_pt)

unsigned	newton_solve_continuation (double *const &parameter_pt, DoubleVector &z)

void	calculate_continuation_derivatives (double *const &parameter_pt)

void	calculate_continuation_derivatives (const DoubleVector &z)

void	calculate_continuation_derivatives_fd (double *const &parameter_pt)

bool	does_pointer_correspond_to_problem_data (double *const &parameter_pt)

void	set_consistent_pinned_values_for_continuation ()

Protected Attributes inherited from oomph::Problem
Vector< Problem * >	Copy_of_problem_pt

std::map< double *, bool >	Calculate_dparameter_analytic

bool	Calculate_hessian_products_analytic

LinearAlgebraDistribution *	Dof_distribution_pt

Vector< double * >	Dof_pt
	Vector of pointers to dofs. More...

DoubleVectorWithHaloEntries	Element_count_per_dof

double	Relaxation_factor

double	Newton_solver_tolerance

unsigned	Max_newton_iterations
	Maximum number of Newton iterations. More...

unsigned	Nnewton_iter_taken

Vector< double >	Max_res
	Maximum residuals at start and after each newton iteration. More...

double	Max_residuals

bool	Time_adaptive_newton_crash_on_solve_fail

bool	Jacobian_reuse_is_enabled
	Is re-use of Jacobian in Newton iteration enabled? Default: false. More...

bool	Jacobian_has_been_computed

bool	Problem_is_nonlinear

bool	Pause_at_end_of_sparse_assembly

bool	Doc_time_in_distribute

unsigned	Sparse_assembly_method

unsigned	Sparse_assemble_with_arrays_initial_allocation

unsigned	Sparse_assemble_with_arrays_allocation_increment

Vector< Vector< unsigned > >	Sparse_assemble_with_arrays_previous_allocation

double	Numerical_zero_for_sparse_assembly

double	FD_step_used_in_get_hessian_vector_products

bool	Mass_matrix_reuse_is_enabled

bool	Mass_matrix_has_been_computed

bool	Discontinuous_element_formulation

double	Minimum_dt
	Minimum desired dt: if dt falls below this value, exit. More...

double	Maximum_dt
	Maximum desired dt. More...

double	DTSF_max_increase

double	DTSF_min_decrease

double	Minimum_dt_but_still_proceed

bool	Scale_arc_length
	Boolean to control whether arc-length should be scaled. More...

double	Desired_proportion_of_arc_length
	Proportion of the arc-length to taken by the parameter. More...

double	Theta_squared

int	Sign_of_jacobian
	Storage for the sign of the global Jacobian. More...

double	Continuation_direction

double	Parameter_derivative
	Storage for the derivative of the global parameter wrt arc-length. More...

double	Parameter_current
	Storage for the present value of the global parameter. More...

bool	Use_continuation_timestepper
	Boolean to control original or new storage of dof stuff. More...

unsigned	Dof_derivative_offset

unsigned	Dof_current_offset

Vector< double >	Dof_derivative
	Storage for the derivative of the problem variables wrt arc-length. More...

Vector< double >	Dof_current
	Storage for the present values of the variables. More...

double	Ds_current
	Storage for the current step value. More...

unsigned	Desired_newton_iterations_ds

double	Minimum_ds
	Minimum desired value of arc-length. More...

bool	Bifurcation_detection
	Boolean to control bifurcation detection via determinant of Jacobian. More...

bool	Bisect_to_find_bifurcation
	Boolean to control wheter bisection is used to located bifurcation. More...

bool	First_jacobian_sign_change
	Boolean to indicate whether a sign change has occured in the Jacobian. More...

bool	Arc_length_step_taken
	Boolean to indicate whether an arc-length step has been taken. More...

bool	Use_finite_differences_for_continuation_derivatives

OomphCommunicator *	Communicator_pt
	The communicator for this problem. More...

bool	Always_take_one_newton_step

double	Timestep_reduction_factor_after_nonconvergence

bool	Keep_temporal_error_below_tolerance

Static Protected Attributes inherited from oomph::Problem
static ContinuationStorageScheme	Continuation_time_stepper
	Storage for the single static continuation timestorage object. More...

Detailed Description

template<class ELEMENT>
class PMLHelmholtzMGProblem< ELEMENT >

/////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// HelmholtzMGProblem class to demonstrate use of perfectly matched layers for Helmholtz problems.

Constructor & Destructor Documentation

◆ PMLHelmholtzMGProblem()

template<class ELEMENT >

PMLHelmholtzMGProblem< ELEMENT >::PMLHelmholtzMGProblem

Constructor.

Constructor for Helmholtz problem.

 {
  // Create boundary information: Outer boundary
  //--------------------------------------------
  TriangleMeshClosedCurve* outer_boundary_pt=0;
  
  Vector<TriangleMeshCurveSection*> outer_boundary_line_pt(4);
  
  // Each polyline only has three vertices, provide storage for their
  // coordinates
  Vector<Vector<double> > vertex_coord(2);
  for(unsigned i=0;i<2;i++)
  {
   vertex_coord[i].resize(2);
  }
  
  // First polyline
  vertex_coord[0][0]=0.0;
  vertex_coord[0][1]=0.0;
  vertex_coord[1][0]=GlobalParameters::Lx;
  vertex_coord[1][1]=0.0;
  
  // Build the 1st boundary polyline
  unsigned boundary_id=2;
  outer_boundary_line_pt[0]=new TriangleMeshPolyLine(vertex_coord,boundary_id);
  
  // Second boundary polyline
  vertex_coord[0][0]=GlobalParameters::Lx;
  vertex_coord[0][1]=0.0;
  vertex_coord[1][0]=GlobalParameters::Lx;
  vertex_coord[1][1]=GlobalParameters::Ly;
  
  // Build the 2nd boundary polyline
  boundary_id=3;
  outer_boundary_line_pt[1]=new TriangleMeshPolyLine(vertex_coord,boundary_id);
  
  // Third boundary polyline
  vertex_coord[0][0]=GlobalParameters::Lx;
  vertex_coord[0][1]=GlobalParameters::Ly;
  vertex_coord[1][0]=0.0;
  vertex_coord[1][1]=GlobalParameters::Ly;
  
  // Build the 3rd boundary polyline
  boundary_id=4;
  outer_boundary_line_pt[2]=new TriangleMeshPolyLine(vertex_coord,boundary_id);
  
  // Fourth boundary polyline
  vertex_coord[0][0]=0.0;
  vertex_coord[0][1]=GlobalParameters::Ly;
  vertex_coord[1][0]=0.0;
  vertex_coord[1][1]=0.0;
  
  // Build the 4th boundary polyline
  boundary_id=5;
  outer_boundary_line_pt[3]=new TriangleMeshPolyLine(vertex_coord,boundary_id);
  
  // Create the triangle mesh polygon for outer boundary
  outer_boundary_pt=new TriangleMeshPolygon(outer_boundary_line_pt);
  
  // Create boundary information: Inner boundary
  //--------------------------------------------
  // Create circle representing inner boundary. We are comparing this problem
  // to a problem with a pinned square. Instead of choosing the value of r
  // such that the diameter of the circle is the same as the side-length of
  // the pinned square we find the value of r such that the area of both
  // regions are equivalent so r=sqrt(0.2^{2}/pi)=0.1128...
  double a=0.1128;
  double x_c=GlobalParameters::Centre;
  double y_c=GlobalParameters::Centre;
  Circle* inner_circle_pt=new Circle(x_c,y_c,a);
  
  // Create storage for curves which will represent the obstacle
  Vector<TriangleMeshCurveSection*> inner_boundary_line_pt(2);
  
  // # of segments for each curve (defining the obstacle in the coarsest mesh)
  unsigned n_segments=GlobalParameters::N_boundary_segment;
  
  // The intrinsic coordinates for the beginning and end of the curve
  double s_start=0.0;
  double s_end=MathematicalConstants::Pi;
  boundary_id=0;
  inner_boundary_line_pt[0]=
   new TriangleMeshCurviLine(inner_circle_pt,
                             s_start,
                             s_end,
                             n_segments,
                             boundary_id);
  
  // The intrinsic coordinates for the beginning and end of the curve
  s_start=MathematicalConstants::Pi;
  s_end=2.0*MathematicalConstants::Pi;
  boundary_id=1;
  inner_boundary_line_pt[1]=
   new TriangleMeshCurviLine(inner_circle_pt,
                             s_start,
                             s_end,
                             n_segments,
                             boundary_id);
  
  // Combine to hole
  //----------------
  Vector<TriangleMeshClosedCurve*> hole_pt(1);
  Vector<double> hole_coords(2);
  hole_coords[0]=GlobalParameters::Centre;
  hole_coords[1]=GlobalParameters::Centre;
  hole_pt[0]=new TriangleMeshClosedCurve(inner_boundary_line_pt,hole_coords);
  
  // Use the TriangleMeshParameters object for helping on the manage
  // of the TriangleMesh parameters. The only parameter that needs to take
  // is the outer boundary.
  TriangleMeshParameters triangle_mesh_parameters(outer_boundary_pt);
  
  // Specify the closed curve using the TriangleMeshParameters object
  triangle_mesh_parameters.internal_closed_curve_pt()=hole_pt;
  
  // Target element size in bulk mesh
  triangle_mesh_parameters.element_area()=0.10;
  
  // Build the mesh using the specified parameters
  //----------------------------------------------
  // Build adaptive "bulk" mesh
  Bulk_mesh_pt=new RefineableQuadFromTriangleMesh<ELEMENT>(
   triangle_mesh_parameters);
  
  // Output
  Bulk_mesh_pt->output("RESLT/mesh.dat",2);
  
  // Create/set error estimator
  Bulk_mesh_pt->spatial_error_estimator_pt()=new Z2ErrorEstimator;
  
  // Choose error tolerances to force some uniform refinement
  Bulk_mesh_pt->min_permitted_error()=0.00004;
  Bulk_mesh_pt->max_permitted_error()=0.0001;
  
  // Create the main triangular mesh
  add_sub_mesh(Bulk_mesh_pt);
  
  // If we're using at least one PML element
  if (0!=GlobalParameters::N_pml_element)
  {
   // Create PML meshes and add them to the global mesh
   create_pml_meshes();
  }
  
  // Build the entire mesh from its submeshes
  build_global_mesh();
  
  // Complete the build of all elements so they are fully functional: 
  //-----------------------------------------------------------------
  // Find out how many elements there are in the mesh
  unsigned n_element=this->mesh_pt()->nelement();
  
  // Loop over the elements in the mesh
  for(unsigned e=0;e<n_element;e++)
  {
   // Upcast from GeneralisedElement to Helmholtz bulk element
   PMLHelmholtzEquations<2>* el_pt =
    dynamic_cast<PMLHelmholtzEquations<2>*>(mesh_pt()->element_pt(e));
  
   // Set the k_squared double pointer
   el_pt->k_squared_pt()=&GlobalParameters::K_squared;
  
   // If we're using Jonathon's new test mapping
   if (GlobalParameters::Enable_test_pml_mapping_flag)
   {
    // Set the PML mapping function
    el_pt->pml_mapping_pt()=GlobalParameters::Test_pml_mapping_pt;
   }
   
   // If we're using GMRES & MG as the linear solver
   if (GlobalParameters::Disable_pml_flag)
   {
    // Disable the PML-ification in these layers
    dynamic_cast<PMLHelmholtzEquations<2>*>
     (mesh_pt()->element_pt(e))->disable_pml();
   }
  } // for(unsigned e=0;e<n_element;e++)
  
  // Apply boundary conditions
  apply_boundary_conditions();
   
  // Setup equation numbering scheme
  assign_eqn_numbers();
  
  // Indicate that the problem is nonlinear to ensure the residual is
  // calculated at the end of the iteration
  problem_is_nonlinear(true);
  
  // Set the number of Newton iterations to one
  max_newton_iterations()=1;
  
  // Set up solver specific information:
  //------------------------------------
  // If we're choosing to use GMRES & MG as our linear solver
  if (GlobalParameters::Linear_solver_flag==1)
  {
   // Set the solver
   set_gmres_multigrid_solver();
  }
  
  // Open trace file
  Trace_file.open("RESLT/trace.dat");
 } // End of the constructor, PMLHelmholtzMGProblem

References a, GlobalParameters::Centre, GlobalParameters::Disable_pml_flag, e(), oomph::TriangleMeshParameters::element_area(), GlobalParameters::Enable_test_pml_mapping_flag, i, oomph::TriangleMeshParameters::internal_closed_curve_pt(), GlobalParameters::K_squared, oomph::PMLHelmholtzEquations< DIM >::k_squared_pt(), GlobalParameters::Linear_solver_flag, GlobalParameters::Lx, GlobalParameters::Ly, GlobalParameters::N_boundary_segment, GlobalParameters::N_pml_element, oomph::MathematicalConstants::Pi, oomph::PMLHelmholtzEquations< DIM >::pml_mapping_pt(), GlobalParameters::Test_pml_mapping_pt, and oomph::Problem_Parameter::Trace_file.

◆ ~PMLHelmholtzMGProblem()

template<class ELEMENT >

PMLHelmholtzMGProblem< ELEMENT >::~PMLHelmholtzMGProblem

Destructor (empty)

Destructor for Helmholtz problem.

 {
  // If we're using GMRES & MG as the linear solver
  if (GlobalParameters::Linear_solver_flag==1)
  {
   // Delete the MG solver pointers
   delete dynamic_cast<HelmholtzGMRESMG<CRDoubleMatrix>* >
    (linear_solver_pt())->preconditioner_pt();
  
   // Set the pointer to null
   dynamic_cast<HelmholtzGMRESMG<CRDoubleMatrix>* >
    (linear_solver_pt())->preconditioner_pt()=0;
   
   // Delete the MG solver pointers
   delete linear_solver_pt();
  
   // Set the pointer to null
   linear_solver_pt()=0;    
  }
    
  // Delete the error estimator (allocated as a 'new' object)
  delete Bulk_mesh_pt->spatial_error_estimator_pt();
  
  // Set the pointer to null
  Bulk_mesh_pt->spatial_error_estimator_pt()=0;
  
  // Delete the "bulk" mesh
  delete Bulk_mesh_pt;
  
  // Set the pointer to null
  Bulk_mesh_pt=0;
  
 } // End of ~PMLHelmholtzMGProblem

References GlobalParameters::Linear_solver_flag.

Member Function Documentation

◆ actions_after_adapt()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::actions_after_adapt

virtual

Actions after adapt: Rebuild the PML meshes.

Actions after adapt: Rebuild the face element meshes.

Reimplemented from oomph::Problem.

 {
  // Re-build the full mesh with PMLs:
  //----------------------------------
  // If we're using at least one PML element
  if (0!=GlobalParameters::N_pml_element)
  {
   // Create PML meshes and add them to the global mesh
   create_pml_meshes(); 
  }
  
  // Build the entire mesh from its submeshes
  rebuild_global_mesh();
   
  // Complete the build of all elements so they are fully functional: 
  //-----------------------------------------------------------------
  // Calculate the number of elements in the mesh
  unsigned n_element=this->mesh_pt()->nelement();
  
  // Loop over the elements
  for(unsigned e=0;e<n_element;e++)
  {
   // Upcast from GeneralisedElement to PMLHelmholtz bulk element
   PMLHelmholtzEquations<2> *el_pt =
    dynamic_cast<PMLHelmholtzEquations<2>*>(mesh_pt()->element_pt(e));
  
   // Set the frequency function pointer
   el_pt->k_squared_pt()=&GlobalParameters::K_squared;
   
   // If we're using Jonathon's new test mapping
   if (GlobalParameters::Enable_test_pml_mapping_flag)
   {
    // Set the PML mapping function
    el_pt->pml_mapping_pt()=GlobalParameters::Test_pml_mapping_pt;
   }
   
   // If we're using GMRES & MG as the linear solver
   if (GlobalParameters::Disable_pml_flag)
   {
    // Disable the PML-ification in these layers
    dynamic_cast<PMLHelmholtzEquations<2>*>
     (mesh_pt()->element_pt(e))->disable_pml();
   }
  } // for(unsigned e=0;e<n_element;e++)
  
  // Re-apply boundary conditions
  apply_boundary_conditions();
 } // End of actions_after_adapt

References GlobalParameters::Disable_pml_flag, e(), GlobalParameters::Enable_test_pml_mapping_flag, GlobalParameters::K_squared, oomph::PMLHelmholtzEquations< DIM >::k_squared_pt(), GlobalParameters::N_pml_element, oomph::PMLHelmholtzEquations< DIM >::pml_mapping_pt(), and GlobalParameters::Test_pml_mapping_pt.

◆ actions_after_newton_solve()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::actions_after_newton_solve ( )

inlinevirtual

Update the problem specs after solve (empty)

Reimplemented from oomph::Problem.

   {
    // Document the solution
    doc_solution();
   }

◆ actions_before_adapt()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::actions_before_adapt

virtual

Actions before adapt: Wipe the PML meshes.

Actions before adapt: Wipe the mesh of face elements.

Reimplemented from oomph::Problem.

 {
  // If we're using at least one PML element
  if (0!=GlobalParameters::N_pml_element)
  {
   // Before adapting the added PML meshes must be removed
   // as they are not refineable and are to be rebuilt from the
   // newly refined triangular mesh
   delete PML_right_mesh_pt;
   PML_right_mesh_pt=0;
   delete PML_top_mesh_pt;
   PML_top_mesh_pt=0;
   delete PML_left_mesh_pt;
   PML_left_mesh_pt=0;
   delete PML_bottom_mesh_pt;
   PML_bottom_mesh_pt=0;
   delete PML_top_right_mesh_pt;
   PML_top_right_mesh_pt=0;
   delete PML_top_left_mesh_pt;
   PML_top_left_mesh_pt=0;
   delete PML_bottom_right_mesh_pt;
   PML_bottom_right_mesh_pt=0;
   delete PML_bottom_left_mesh_pt;
   PML_bottom_left_mesh_pt=0;
  
   // Rebuild the HelmholtzMGProblem's global mesh from its various sub-meshes
   // but first flush all its submeshes
   flush_sub_meshes();
  
   // Then add the triangular mesh back
   add_sub_mesh(Bulk_mesh_pt);
  
   //  Rebuild the global mesh such that it now stores
   // the triangular mesh only
   rebuild_global_mesh();
  }
 } // End of actions_before_adapt

References GlobalParameters::N_pml_element.

◆ actions_before_newton_solve()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::actions_before_newton_solve ( )

inlinevirtual

Update the problem specs before solve (empty)

Reimplemented from oomph::Problem.

332 {}

◆ apply_boundary_conditions()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::apply_boundary_conditions

Apply boundary conditions.

 {
  // Boundary conditions are set on the surface of the circle
  // as a constant nonzero Dirichlet boundary condition
  unsigned n_bound=Bulk_mesh_pt->nboundary();
  
  // Vector to hold the coordinates of the node
  Vector<double> x(2,0.0);
  
  // Vector to hold the solution at the given node (first entry holds
  // the real part and the second entry holds the imaginary part)
  Vector<double> u(2,0.0);
  
  // Loop over the boundaries
  for(unsigned b=0;b<n_bound;b++)
  {
   // Find the number of nodes on the b-th boundary
   unsigned n_node=Bulk_mesh_pt->nboundary_node(b);
  
   // Loop over the nodes on boundary b
   for (unsigned n=0;n<n_node;n++)
   {
    // If we're on the boundary of the obstacle (remembering that
    // the circle has been broken up into two semi-circle boundaries)
    if ((0==b) || (1==b))
    {
     Node* nod_pt=Bulk_mesh_pt->boundary_node_pt(b,n);
     nod_pt->pin(0);
     nod_pt->pin(1);
  
     // Get the coordinates of the node
     for (unsigned k=0;k<2;k++)
     {
      // Store the k-th coordinate value
      x[k]=nod_pt->x(k);
     }
  
     // Get the solution at this point (default setting -- Bessel solution)
     GlobalParameters::simple_exact_u_pt(x,u);
     
     // Set the values at each dof
     nod_pt->set_value(0,u[0]);
     nod_pt->set_value(1,u[1]);
    }
   } // for (unsigned n=0;n<n_node;n++)
  } // for(unsigned b=0;b<n_bound;b++)
  
  // If we're not using any PML elements
  if (0==GlobalParameters::N_pml_element)
  {
   // Loop over the outer boundaries (not the circle boundary)
   for(unsigned b=2;b<n_bound;b++)
   {
    // Find the number of nodes on the b-th boundary
    unsigned n_node=Bulk_mesh_pt->nboundary_node(b);
  
    // Loop over the nodes on boundary b
    for (unsigned n=0;n<n_node;n++)
    {
     // Grab the n-th node on the b-th boundary
     Node* nod_pt=Bulk_mesh_pt->boundary_node_pt(b,n);
  
     // Pin the first dof at this node
     nod_pt->pin(0);
  
     // Pin the second dof at this node
     nod_pt->pin(1);
  
     // Set the value of the first dof
     nod_pt->set_value(0,0.0);
      
     // Set the value of the second dof
     nod_pt->set_value(1,0.0);
    } // for (unsigned n=0;n<n_node;n++)
   } // for(unsigned b=0;b<n_bound;b++)
  } // if (GlobalParameters::Disable_pml_flag)
 } // End of apply_boundary_conditions

References b, k, n, GlobalParameters::N_pml_element, oomph::Data::pin(), oomph::Data::set_value(), GlobalParameters::simple_exact_u_pt, plotDoE::x, and oomph::Node::x().

◆ create_pml_meshes()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::create_pml_meshes

Create PML meshes.

Create PML meshes and add them to the problem's sub-meshes.

 {
  // Bulk mesh bottom boundary id
  unsigned int bottom_boundary_id=2;
  
  // Bulk mesh right boundary id
  unsigned int right_boundary_id=3;
  
  // Bulk mesh top boundary id
  unsigned int top_boundary_id=4;
  
  // Bulk mesh left boundary id
  unsigned int left_boundary_id=5;
  
  // PML width in elements for the right layer
  unsigned n_x_right_pml=GlobalParameters::N_pml_element;
  
  // PML width in elements for the top layer
  unsigned n_y_top_pml=GlobalParameters::N_pml_element;
  
  // PML width in elements for the left layer
  unsigned n_x_left_pml=GlobalParameters::N_pml_element;
  
  // PML width in elements for the left layer
  unsigned n_y_bottom_pml=GlobalParameters::N_pml_element;
  
  // Outer physical length of the PML layers
  double width_x_right_pml=GlobalParameters::Pml_thickness;
  double width_y_top_pml=GlobalParameters::Pml_thickness;
  double width_x_left_pml=GlobalParameters::Pml_thickness;
  double width_y_bottom_pml=GlobalParameters::Pml_thickness;
  
  // Build the PML meshes based on the new adapted triangular mesh
  PML_right_mesh_pt=
   TwoDimensionalPMLHelper::create_right_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (Bulk_mesh_pt,right_boundary_id,
    n_x_right_pml, width_x_right_pml);
  PML_top_mesh_pt=
   TwoDimensionalPMLHelper::create_top_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (Bulk_mesh_pt, top_boundary_id,
    n_y_top_pml, width_y_top_pml);
  PML_left_mesh_pt=
   TwoDimensionalPMLHelper::create_left_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (Bulk_mesh_pt, left_boundary_id,
    n_x_left_pml, width_x_left_pml);
  PML_bottom_mesh_pt=
   TwoDimensionalPMLHelper::create_bottom_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (Bulk_mesh_pt, bottom_boundary_id,
    n_y_bottom_pml, width_y_bottom_pml);
  
  // Add submeshes to the global mesh
  add_sub_mesh(PML_right_mesh_pt);
  add_sub_mesh(PML_top_mesh_pt);
  add_sub_mesh(PML_left_mesh_pt);
  add_sub_mesh(PML_bottom_mesh_pt);
  
  // Rebuild corner PML meshes
  PML_top_right_mesh_pt=
   TwoDimensionalPMLHelper::create_top_right_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (PML_right_mesh_pt, PML_top_mesh_pt,
    Bulk_mesh_pt, right_boundary_id);
  
  PML_bottom_right_mesh_pt=
   TwoDimensionalPMLHelper::create_bottom_right_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (PML_right_mesh_pt, PML_bottom_mesh_pt,
    Bulk_mesh_pt, right_boundary_id);
  
  PML_top_left_mesh_pt=
   TwoDimensionalPMLHelper::create_top_left_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (PML_left_mesh_pt, PML_top_mesh_pt,
    Bulk_mesh_pt, left_boundary_id);
  
  PML_bottom_left_mesh_pt=
   TwoDimensionalPMLHelper::create_bottom_left_pml_mesh
   <PMLLayerElement<ELEMENT> >
   (PML_left_mesh_pt, PML_bottom_mesh_pt,
    Bulk_mesh_pt, left_boundary_id);
  
  // Add submeshes to the global mesh
  add_sub_mesh(PML_top_right_mesh_pt);
  add_sub_mesh(PML_bottom_right_mesh_pt);
  add_sub_mesh(PML_top_left_mesh_pt);
  add_sub_mesh(PML_bottom_left_mesh_pt);
  
 } // End of create_pml_meshes

References oomph::TwoDimensionalPMLHelper::create_bottom_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_bottom_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_bottom_right_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_right_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_right_pml_mesh(), GlobalParameters::N_pml_element, and GlobalParameters::Pml_thickness.

◆ doc_solution()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::doc_solution

Doc the solution: doc_info contains labels/output directory etc.

Doc the solution. DocInfo object stores flags/labels for where the output gets written to

 {
  // Create an output stream
  ofstream some_file;
  
  // Create space for the file name
  char filename[100];
  
  // Number of plot points
  unsigned npts=5;
  
  // Number of plot points in the coarse solution
  unsigned npts_coarse=2;
  
  // Output solution
  //-----------------
  sprintf(filename,"%s/soln%i.dat",
      GlobalParameters::Doc_info.directory().c_str(),
          GlobalParameters::Doc_info.number());
  some_file.open(filename);
  Bulk_mesh_pt->output(some_file,npts);
  some_file.close();
  
  // Ouput exact solution
  //---------------------
  sprintf(filename,"%s/exact_soln%i.dat",
      GlobalParameters::Doc_info.directory().c_str(),
      GlobalParameters::Doc_info.number());
  some_file.open(filename);
  Bulk_mesh_pt->output_fct(some_file,npts,GlobalParameters::simple_exact_u_pt);
  some_file.close();
  
  // If we're using at least one PML element
  if (0!=GlobalParameters::N_pml_element)
  {  
   // Output solution within pml domains
   //-----------------------------------
   sprintf(filename,"%s/pml_soln%i.dat",
       GlobalParameters::Doc_info.directory().c_str(),
       GlobalParameters::Doc_info.number());
   some_file.open(filename);
   PML_top_mesh_pt->output(some_file,npts);
   PML_right_mesh_pt->output(some_file,npts);
   PML_bottom_mesh_pt->output(some_file,npts);
   PML_left_mesh_pt->output(some_file,npts);
   PML_top_right_mesh_pt->output(some_file,npts);
   PML_bottom_right_mesh_pt->output(some_file,npts);
   PML_top_left_mesh_pt->output(some_file,npts);
   PML_bottom_left_mesh_pt->output(some_file,npts);
   some_file.close();
  }
  
  // Output coarse solution
  //-----------------------
  sprintf(filename,"%s/coarse_soln%i.dat",
      GlobalParameters::Doc_info.directory().c_str(),
          GlobalParameters::Doc_info.number());
  some_file.open(filename);
  Bulk_mesh_pt->output(some_file,npts_coarse);
  some_file.close();
  
  // If we're using at least one PML element
  if (0!=GlobalParameters::N_pml_element)
  {  
   // Output coarse solution within pml domains
   //------------------------------------------
   sprintf(filename,"%s/coarse_pml_soln%i.dat",
       GlobalParameters::Doc_info.directory().c_str(),
       GlobalParameters::Doc_info.number());
   some_file.open(filename);
   PML_top_mesh_pt->output(some_file,npts_coarse);
   PML_right_mesh_pt->output(some_file,npts_coarse);
   PML_bottom_mesh_pt->output(some_file,npts_coarse);
   PML_left_mesh_pt->output(some_file,npts_coarse);
   PML_top_right_mesh_pt->output(some_file,npts_coarse);
   PML_bottom_right_mesh_pt->output(some_file,npts_coarse);
   PML_top_left_mesh_pt->output(some_file,npts_coarse);
   PML_bottom_left_mesh_pt->output(some_file,npts_coarse);
   some_file.close();
  }
  
  // Increment the documentation counter
  GlobalParameters::Doc_info.number()++;
  
  // Doc error and solution norm
  //---------------------------- 
  double error,norm;
  sprintf(filename,"%s/error%i.dat",
      GlobalParameters::Doc_info.directory().c_str(),
          GlobalParameters::Doc_info.number());
  some_file.open(filename);
  Bulk_mesh_pt->compute_error(some_file,
                  GlobalParameters::simple_exact_u_pt,
                  error,norm); 
  some_file.close();
  
  // Document the L2 norm of the error and the L2 norm of the solution
  cout << "\nNorm of error         : " << error
       << "\nNorm of solution      : " << norm
       << "\nNormalised error norm : " << error/norm << std::endl;
  
  // Write the L2 norm of the solution to the trace file
  Trace_file << norm << std::endl;
 } // End of doc

References GlobalParameters::Doc_info, calibrate::error, MergeRestartFiles::filename, GlobalParameters::N_pml_element, oomph::DocInfo::number(), GlobalParameters::simple_exact_u_pt, and oomph::Problem_Parameter::Trace_file.

◆ make_new_problem()

template<class ELEMENT >

HelmholtzMGProblem* PMLHelmholtzMGProblem< ELEMENT >::make_new_problem ( )

inlineprivatevirtual

Overload the make_new_problem function to return an object of this class.

Implements oomph::HelmholtzMGProblem.

   {
    // Return a new problem pointer
    return new PMLHelmholtzMGProblem<ELEMENT>;
   }

◆ mg_bulk_mesh_pt()

template<class ELEMENT >

TreeBasedRefineableMeshBase* PMLHelmholtzMGProblem< ELEMENT >::mg_bulk_mesh_pt ( )

inlineprivatevirtual

Overload the mg_bulk_mesh_pt function to return a pointer to the "refineable" portion of the mesh

Implements oomph::HelmholtzMGProblem.

   {
    // Return the pointer to the bulk mesh
    return Bulk_mesh_pt;
   }

◆ set_gmres_multigrid_solver()

template<class ELEMENT >

void PMLHelmholtzMGProblem< ELEMENT >::set_gmres_multigrid_solver

Set GMRES preconditioner by multigrid as the linear solver.

Build and set GMRES preconditioner by multigrid as the linear solver.

 {
  // Create linear solver
  HelmholtzGMRESMG<CRDoubleMatrix>* solver_pt=
   new HelmholtzGMRESMG<CRDoubleMatrix>;
  
  // Use RHS preconditioning
  solver_pt->set_preconditioner_RHS();
  
  // Set the maximum number of iterations
  solver_pt->max_iter()=200;
  
  // Set the tolerance (to ensure the Newton solver converges in one step)
  solver_pt->tolerance()=1.0e-10;
    
  // If the user wishes to document the convergence information
  if (GlobalParameters::Doc_convergence_flag)
  {
   // Create a file to record the convergence history
   solver_pt->open_convergence_history_file_stream("RESLT/conv.dat");
  }
  
  // Create linear solver 
  linear_solver_pt()=solver_pt;
  
  // This preconditioner uses multigrid on the block version of the full
  // matrix. 2 V-cycles will be used here per preconditioning step
  HelmholtzMGPreconditioner<2>* prec_pt=new HelmholtzMGPreconditioner<2>(this);
  
  // Set preconditioner
  solver_pt->preconditioner_pt()=prec_pt;
   
  // Set the shift
  prec_pt->alpha_shift()=GlobalParameters::Alpha_shift;
  
  // If the user wants to use damped Jacobi on every level as a smoother
  if (GlobalParameters::Pre_smoother_flag==1)
  {
   // Set the pre-smoother factory function
   prec_pt->set_pre_smoother_factory_function
    (Smoother_Factory_Function_Helper::set_pre_smoother);
  }
  
  // If the user wants to use damped Jacobi on every level as a smoother
  if (GlobalParameters::Post_smoother_flag==1)
  {
   // Set the post-smoother factory function
   prec_pt->set_post_smoother_factory_function
    (Smoother_Factory_Function_Helper::set_post_smoother);
  }
  
  // Suppress certain timings
  if (GlobalParameters::Output_management_flag==1)
  {
   // Disable smoother timings
   prec_pt->disable_doc_time();
  }
  else if (GlobalParameters::Output_management_flag==2)
  {
   // Disable all output from the V-cycle
   prec_pt->disable_v_cycle_output();
  }
  else if (GlobalParameters::Output_management_flag==3)
  {
   // Suppress all output
   prec_pt->disable_output();
  }
 } // End of set_gmres_multigrid_solver

References GlobalParameters::Alpha_shift, oomph::HelmholtzMGPreconditioner< DIM >::alpha_shift(), oomph::HelmholtzMGPreconditioner< DIM >::disable_doc_time(), oomph::HelmholtzMGPreconditioner< DIM >::disable_output(), oomph::HelmholtzMGPreconditioner< DIM >::disable_v_cycle_output(), GlobalParameters::Doc_convergence_flag, oomph::IterativeLinearSolver::max_iter(), oomph::IterativeLinearSolver::open_convergence_history_file_stream(), GlobalParameters::Output_management_flag, GlobalParameters::Post_smoother_flag, GlobalParameters::Pre_smoother_flag, oomph::IterativeLinearSolver::preconditioner_pt(), Smoother_Factory_Function_Helper::set_post_smoother(), oomph::HelmholtzMGPreconditioner< DIM >::set_post_smoother_factory_function(), Smoother_Factory_Function_Helper::set_pre_smoother(), oomph::HelmholtzMGPreconditioner< DIM >::set_pre_smoother_factory_function(), oomph::HelmholtzGMRESMG< MATRIX >::set_preconditioner_RHS(), and oomph::IterativeLinearSolver::tolerance().

Member Data Documentation

◆ Bulk_mesh_pt

template<class ELEMENT >

RefineableQuadFromTriangleMesh<ELEMENT>* PMLHelmholtzMGProblem< ELEMENT >::Bulk_mesh_pt

private

Pointer to the refineable "bulk" mesh.

◆ PML_bottom_left_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_bottom_left_mesh_pt

private

Pointer to the bottom left corner PML mesh.

◆ PML_bottom_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_bottom_mesh_pt

private

Pointer to the bottom PML mesh.

◆ PML_bottom_right_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_bottom_right_mesh_pt

private

Pointer to the bottom right corner PML mesh.

◆ PML_left_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_left_mesh_pt

private

Pointer to the left PML mesh.

◆ PML_right_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_right_mesh_pt

private

Pointer to the right PML mesh.

◆ PML_top_left_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_top_left_mesh_pt

private

Pointer to the top left corner PML mesh.

◆ PML_top_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_top_mesh_pt

private

Pointer to the top PML mesh.

◆ PML_top_right_mesh_pt

template<class ELEMENT >

Mesh* PMLHelmholtzMGProblem< ELEMENT >::PML_top_right_mesh_pt

private

Pointer to the top right corner PML mesh.

◆ Trace_file

template<class ELEMENT >

ofstream PMLHelmholtzMGProblem< ELEMENT >::Trace_file

private

Trace file.

The documentation for this class was generated from the following file:

multigrid/helmholtz_multigrid/unstructured_two_d_helmholtz.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class ELEMENT> class PMLHelmholtzMGProblem< ELEMENT >

Constructor & Destructor Documentation

◆ PMLHelmholtzMGProblem()

◆ ~PMLHelmholtzMGProblem()

Member Function Documentation

◆ actions_after_adapt()

◆ actions_after_newton_solve()

◆ actions_before_adapt()

◆ actions_before_newton_solve()

◆ apply_boundary_conditions()

◆ create_pml_meshes()

◆ doc_solution()

◆ make_new_problem()

◆ mg_bulk_mesh_pt()

◆ set_gmres_multigrid_solver()

Member Data Documentation

◆ Bulk_mesh_pt

◆ PML_bottom_left_mesh_pt

◆ PML_bottom_mesh_pt

◆ PML_bottom_right_mesh_pt

◆ PML_left_mesh_pt

◆ PML_right_mesh_pt

◆ PML_top_left_mesh_pt

◆ PML_top_mesh_pt

◆ PML_top_right_mesh_pt

◆ Trace_file

template<class ELEMENT>
class PMLHelmholtzMGProblem< ELEMENT >