oomph::LineMeshBase Class Reference

Base class for line meshes (meshes made of 1D line elements) More...

#include <line_mesh.h>

Inheritance diagram for oomph::LineMeshBase:

Public Member Functions
	LineMeshBase ()
	Constructor (empty) More...
	LineMeshBase (const LineMeshBase &node)=delete
	Broken copy constructor. More...
void	operator= (const LineMeshBase &)=delete
	Broken assignment operator. More...
virtual	~LineMeshBase ()
	Destructor (empty) More...
void	setup_boundary_element_info ()
void	setup_boundary_element_info (std::ostream &outfile)
Public Member Functions inherited from oomph::Mesh
	Mesh ()
	Default constructor. More...
	Mesh (const Vector< Mesh * > &sub_mesh_pt)
void	merge_meshes (const Vector< Mesh * > &sub_mesh_pt)
virtual void	reset_boundary_element_info (Vector< unsigned > &ntmp_boundary_elements, Vector< Vector< unsigned >> &ntmp_boundary_elements_in_region, Vector< FiniteElement * > &deleted_elements)
	Virtual function to perform the reset boundary elements info rutines. More...
template<class BULK_ELEMENT >
void	doc_boundary_coordinates (const unsigned &b, std::ofstream &the_file)
virtual void	scale_mesh (const double &factor)
	Mesh (const Mesh &dummy)=delete
	Broken copy constructor. More...
void	operator= (const Mesh &)=delete
	Broken assignment operator. More...
virtual	~Mesh ()
	Virtual Destructor to clean up all memory. More...
void	flush_element_and_node_storage ()
void	flush_element_storage ()
void	flush_node_storage ()
Node *&	node_pt (const unsigned long &n)
	Return pointer to global node n. More...
Node *	node_pt (const unsigned long &n) const
	Return pointer to global node n (const version) More...
GeneralisedElement *&	element_pt (const unsigned long &e)
	Return pointer to element e. More...
GeneralisedElement *	element_pt (const unsigned long &e) const
	Return pointer to element e (const version) More...
const Vector< GeneralisedElement * > &	element_pt () const
	Return reference to the Vector of elements. More...
Vector< GeneralisedElement * > &	element_pt ()
	Return reference to the Vector of elements. More...
FiniteElement *	finite_element_pt (const unsigned &e) const
Node *&	boundary_node_pt (const unsigned &b, const unsigned &n)
	Return pointer to node n on boundary b. More...
Node *	boundary_node_pt (const unsigned &b, const unsigned &n) const
	Return pointer to node n on boundary b. More...
void	set_nboundary (const unsigned &nbound)
	Set the number of boundaries in the mesh. More...
void	remove_boundary_nodes ()
	Clear all pointers to boundary nodes. More...
void	remove_boundary_nodes (const unsigned &b)
void	remove_boundary_node (const unsigned &b, Node *const &node_pt)
	Remove a node from the boundary b. More...
void	add_boundary_node (const unsigned &b, Node *const &node_pt)
	Add a (pointer to) a node to the b-th boundary. More...
void	copy_boundary_node_data_from_nodes ()
bool	boundary_coordinate_exists (const unsigned &i) const
	Indicate whether the i-th boundary has an intrinsic coordinate. More...
unsigned long	nelement () const
	Return number of elements in the mesh. More...
unsigned long	nnode () const
	Return number of nodes in the mesh. More...
unsigned	ndof_types () const
	Return number of dof types in mesh. More...
unsigned	elemental_dimension () const
	Return number of elemental dimension in mesh. More...
unsigned	nodal_dimension () const
	Return number of nodal dimension in mesh. More...
void	add_node_pt (Node *const &node_pt)
	Add a (pointer to a) node to the mesh. More...
void	add_element_pt (GeneralisedElement *const &element_pt)
	Add a (pointer to) an element to the mesh. More...
virtual void	node_update (const bool &update_all_solid_nodes=false)
virtual void	reorder_nodes (const bool &use_old_ordering=true)
virtual void	get_node_reordering (Vector< Node * > &reordering, const bool &use_old_ordering=true) const
template<class BULK_ELEMENT , template< class > class FACE_ELEMENT>
void	build_face_mesh (const unsigned &b, Mesh *const &face_mesh_pt)
unsigned	self_test ()
	Self-test: Check elements and nodes. Return 0 for OK. More...
void	max_and_min_element_size (double &max_size, double &min_size)
double	total_size ()
void	check_inverted_elements (bool &mesh_has_inverted_elements, std::ofstream &inverted_element_file)
void	check_inverted_elements (bool &mesh_has_inverted_elements)
unsigned	check_for_repeated_nodes (const double &epsilon=1.0e-12)
Vector< Node * >	prune_dead_nodes ()
unsigned	nboundary () const
	Return number of boundaries. More...
unsigned long	nboundary_node (const unsigned &ibound) const
	Return number of nodes on a particular boundary. More...
FiniteElement *	boundary_element_pt (const unsigned &b, const unsigned &e) const
	Return pointer to e-th finite element on boundary b. More...
Node *	get_some_non_boundary_node () const
unsigned	nboundary_element (const unsigned &b) const
	Return number of finite elements that are adjacent to boundary b. More...
int	face_index_at_boundary (const unsigned &b, const unsigned &e) const
virtual void	dump (std::ofstream &dump_file, const bool &use_old_ordering=true) const
	Dump the data in the mesh into a file for restart. More...
void	dump (const std::string &dump_file_name, const bool &use_old_ordering=true) const
	Dump the data in the mesh into a file for restart. More...
virtual void	read (std::ifstream &restart_file)
	Read solution from restart file. More...
void	output_paraview (std::ofstream &file_out, const unsigned &nplot) const
void	output_fct_paraview (std::ofstream &file_out, const unsigned &nplot, FiniteElement::SteadyExactSolutionFctPt exact_soln_pt) const
void	output_fct_paraview (std::ofstream &file_out, const unsigned &nplot, const double &time, FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt) const
void	output (std::ostream &outfile)
	Output for all elements. More...
void	output (std::ostream &outfile, const unsigned &n_plot)
	Output at f(n_plot) points in each element. More...
void	output (FILE *file_pt)
	Output for all elements (C-style output) More...
void	output (FILE *file_pt, const unsigned &nplot)
	Output at f(n_plot) points in each element (C-style output) More...
void	output (const std::string &output_filename)
	Output for all elements. More...
void	output (const std::string &output_filename, const unsigned &n_plot)
	Output at f(n_plot) points in each element. More...
void	output_fct (std::ostream &outfile, const unsigned &n_plot, FiniteElement::SteadyExactSolutionFctPt)
	Output a given Vector function at f(n_plot) points in each element. More...
void	output_fct (std::ostream &outfile, const unsigned &n_plot, const double &time, FiniteElement::UnsteadyExactSolutionFctPt)
void	output_boundaries (std::ostream &outfile)
	Output the nodes on the boundaries (into separate tecplot zones) More...
void	output_boundaries (const std::string &output_filename)
void	assign_initial_values_impulsive ()
	Assign initial values for an impulsive start. More...
void	shift_time_values ()
void	calculate_predictions ()
void	set_nodal_and_elemental_time_stepper (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)
virtual void	set_mesh_level_time_stepper (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)
void	set_consistent_pinned_values_for_continuation (ContinuationStorageScheme *const &continuation_stepper_pt)
	Set consistent values for pinned data in continuation. More...
bool	does_pointer_correspond_to_mesh_data (double *const &parameter_pt)
	Does the double pointer correspond to any mesh data. More...
void	set_nodal_time_stepper (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)
	Set the timestepper associated with the nodal data in the mesh. More...
void	set_elemental_internal_time_stepper (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)
virtual void	compute_norm (double &norm)
virtual void	compute_norm (Vector< double > &norm)
virtual void	compute_error (std::ostream &outfile, FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt, const double &time, double &error, double &norm)
virtual void	compute_error (std::ostream &outfile, FiniteElement::SteadyExactSolutionFctPt exact_soln_pt, double &error, double &norm)
virtual void	compute_error (FiniteElement::SteadyExactSolutionFctPt exact_soln_pt, double &error, double &norm)
virtual void	compute_error (FiniteElement::SteadyExactSolutionFctPt exact_soln_pt, Vector< double > &error, Vector< double > &norm)
virtual void	compute_error (std::ostream &outfile, FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt, const double &time, Vector< double > &error, Vector< double > &norm)
virtual void	compute_error (std::ostream &outfile, FiniteElement::SteadyExactSolutionFctPt exact_soln_pt, Vector< double > &error, Vector< double > &norm)
virtual void	compute_error (FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt, const double &time, double &error, double &norm)
	Returns the norm of the error and that of the exact solution. More...
virtual void	compute_error (FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt, const double &time, Vector< double > &error, Vector< double > &norm)
bool	is_mesh_distributed () const
	Boolean to indicate if Mesh has been distributed. More...
OomphCommunicator *	communicator_pt () const
void	delete_all_external_storage ()
	Wipe the storage for all externally-based elements. More...

Additional Inherited Members
Public Types inherited from oomph::Mesh
typedef void(FiniteElement::*	SteadyExactSolutionFctPt) (const Vector< double > &x, Vector< double > &soln)
typedef void(FiniteElement::*	UnsteadyExactSolutionFctPt) (const double &time, const Vector< double > &x, Vector< double > &soln)
Static Public Attributes inherited from oomph::Mesh
static Steady< 0 >	Default_TimeStepper
	The Steady Timestepper. More...
static bool	Suppress_warning_about_empty_mesh_level_time_stepper_function
	Static boolean flag to control warning about mesh level timesteppers. More...
Protected Member Functions inherited from oomph::Mesh
unsigned long	assign_global_eqn_numbers (Vector< double * > &Dof_pt)
	Assign (global) equation numbers to the nodes. More...
void	describe_dofs (std::ostream &out, const std::string &current_string) const
void	describe_local_dofs (std::ostream &out, const std::string &current_string) const
void	assign_local_eqn_numbers (const bool &store_local_dof_pt)
	Assign local equation numbers in all elements. More...
void	convert_to_boundary_node (Node *&node_pt, const Vector< FiniteElement * > &finite_element_pt)
void	convert_to_boundary_node (Node *&node_pt)
Protected Attributes inherited from oomph::Mesh
Vector< Vector< Node * > >	Boundary_node_pt
bool	Lookup_for_elements_next_boundary_is_setup
Vector< Vector< FiniteElement * > >	Boundary_element_pt
Vector< Vector< int > >	Face_index_at_boundary
Vector< Node * >	Node_pt
	Vector of pointers to nodes. More...
Vector< GeneralisedElement * >	Element_pt
	Vector of pointers to generalised elements. More...
std::vector< bool >	Boundary_coordinate_exists

Detailed Description

Base class for line meshes (meshes made of 1D line elements)

Constructor & Destructor Documentation

LineMeshBase() [1/2]

oomph::LineMeshBase::LineMeshBase ( )

inline

Constructor (empty)

{}

LineMeshBase() [2/2]

oomph::LineMeshBase::LineMeshBase ( const LineMeshBase &  node )

delete

Broken copy constructor.

~LineMeshBase()

virtual oomph::LineMeshBase::~LineMeshBase ( )

inlinevirtual

Destructor (empty)

{}

Member Function Documentation

operator=()

void oomph::LineMeshBase::operator= ( const LineMeshBase &  )

delete

Broken assignment operator.

setup_boundary_element_info() [1/2]

void oomph::LineMeshBase::setup_boundary_element_info ( )

inlinevirtual

Set up lookup schemes which establish which elements are located next to mesh's boundaries (wrapper to suppress doc)

Reimplemented from oomph::Mesh.

    {
      std::ofstream outfile;
      setup_boundary_element_info(outfile);
    }

setup_boundary_element_info() [2/2]

void oomph::LineMeshBase::setup_boundary_element_info ( std::ostream &  outfile )

virtual

Set up lookup schemes which establish which elements are located next to mesh's boundaries. Doc in outfile (if it's open).

Set up lookup schemes which establish which elements are located next to which boundaries (doc to outfile if it's open)

Reimplemented from oomph::Mesh.

  {
    // Initialise documentation flag
    bool doc = false;
 
    // Set this to true if an open file has been passed to the function
    if (outfile)
    {
      doc = true;
    }
 
    // Determine number of boundaries in mesh
    const unsigned n_bound = nboundary();
 
    // Wipe/allocate storage for arrays
    Boundary_element_pt.clear();
    Face_index_at_boundary.clear();
    Boundary_element_pt.resize(n_bound);
    Face_index_at_boundary.resize(n_bound);
 
    // Matrix map for working out the fixed local coord for elements on boundary
    MapMatrixMixed<unsigned, FiniteElement*, Vector<int>*> boundary_identifier;
 
    // Determine number of elements in the mesh
    const unsigned n_element = nelement();
 
    // Loop over elements
    for (unsigned e = 0; e < n_element; e++)
    {
      // Get pointer to element
      FiniteElement* fe_pt = finite_element_pt(e);
 
      // Output information to output file
      if (doc)
      {
        outfile << "Element: " << e << " " << fe_pt << std::endl;
      }
 
      // Only include 1D elements! Some meshes contain interface elements too.
      if (fe_pt->dim() == 1)
      {
        // Loop over the element's nodes and find out which boundaries they're
        // on
        // ----------------------------------------------------------------------
 
        // Determine number of nodes in the element
        const unsigned n_node = fe_pt->nnode_1d();
 
        // Loop over nodes in order
        for (unsigned n = 0; n < n_node; n++)
        {
          // Allocate storage for pointer to set of boundaries that node lives
          // on
          std::set<unsigned>* boundaries_pt = 0;
 
          // Get pointer to vector of boundaries that this node lives on
          fe_pt->node_pt(n)->get_boundaries_pt(boundaries_pt);
 
          // If the node lives on some boundaries....
          if (boundaries_pt != 0)
          {
            // Determine number of boundaries which node lives on
            const unsigned n_bound_node_lives_on = (*boundaries_pt).size();
 
            // Throw an error if the node lives on more than one boundary
            if (n_bound_node_lives_on > 1)
            {
              std::string error_message =
                "In a 1D mesh a node shouldn't be able to live on more than\n";
              error_message += "one boundary, yet this node claims to.";
 
              throw OomphLibError(error_message,
                                  OOMPH_CURRENT_FUNCTION,
                                  OOMPH_EXCEPTION_LOCATION);
            }
            // If the node lives on just one boundary
            else if (n_bound_node_lives_on == 1)
            {
              // Determine which boundary the node lives on
              const std::set<unsigned>::iterator boundary =
                boundaries_pt->begin();
 
              // In 1D if an element has any nodes on a boundary then it must
              // be a boundary element. This means that (unlike in the 2D and
              // 3D cases) we can immediately add this element to permanent
              // storage.
              Boundary_element_pt[*boundary].push_back(fe_pt);
 
              // Record information required for FaceElements.
              // `Face_index_at_boundary' = -/+1 for nodes on the left/right
              // boundary. This allows us to decide which edge of the element
              // coincides with the boundary since the line element must have
              // precisely one vertex node on the boundary.
 
              // Are we at the left-hand vertex node? (left face)
              if (n == 0)
              {
                Face_index_at_boundary[*boundary].push_back(-1);
              }
 
              // Are we at the right-hand vertex node? (right face)
              else if (n == n_node - 1)
              {
                Face_index_at_boundary[*boundary].push_back(1);
              }
            }
          } // End of if node lives on some boundaries
 
        } // End of loop over nodes
      }
    } // End of loop over elements
 
#ifdef PARANOID
 
    // Check each boundary only has precisely one element next to it
    // -------------------------------------------------------------
    // Only if not distributed
#ifdef OOMPH_HAS_MPI
    if (Comm_pt == 0)
#endif
    {
      // Loop over boundaries
      for (unsigned b = 0; b < n_bound; b++)
      {
        // Evaluate number of elements adjacent to boundary b
        const unsigned n_element = Boundary_element_pt[b].size();
 
        switch (n_element)
        {
            // Boundary b has no adjacent elements
          case 0:
          {
            std::ostringstream error_stream;
            error_stream << "Boundary " << b
                         << " has no element adjacent to it\n";
            throw OomphLibError(error_stream.str(),
                                OOMPH_CURRENT_FUNCTION,
                                OOMPH_EXCEPTION_LOCATION);
            break;
          }
          // Boundary b has one adjacent element (this is good!)
          case 1:
            break;
 
            // Boundary b has more than one adjacent element
          default:
          {
            std::ostringstream error_stream;
            error_stream << "Boundary " << b << " has " << n_element
                         << " elements adjacent to it.\n"
                         << "This shouldn't occur in a 1D mesh.\n";
            throw OomphLibError(error_stream.str(),
                                OOMPH_CURRENT_FUNCTION,
                                OOMPH_EXCEPTION_LOCATION);
            break;
          }
        } // End of switch
 
        // Because each boundary should only have one element adjacent to it,
        // each `Face_index_at_boundary[b]' should be of size one.
 
        const unsigned face_index_at_boundary_size =
          Face_index_at_boundary[b].size();
 
        if (face_index_at_boundary_size != 1)
        {
          std::ostringstream error_stream;
          error_stream
            << "Face_index_at_boundary[" << b << "] has size"
            << face_index_at_boundary_size << " which does not make sense.\n"
            << "In a 1D mesh its size should always be one since only\n"
            << "one element can be adjacent to any particular boundary";
          throw OomphLibError(error_stream.str(),
                              OOMPH_CURRENT_FUNCTION,
                              OOMPH_EXCEPTION_LOCATION);
        }
      } // End of loop over boundaries
    }
#endif
 
    // Doc?
    // ----
    if (doc)
    {
      // Loop over boundaries
      for (unsigned b = 0; b < n_bound; b++)
      {
        const unsigned n_element = Boundary_element_pt[b].size();
        outfile << "Boundary: " << b << " is adjacent to " << n_element
                << " elements" << std::endl;
 
        // Loop over elements on given boundary
        for (unsigned e = 0; e < n_element; e++)
        {
          FiniteElement* fe_pt = Boundary_element_pt[b][e];
          outfile << "Boundary element:" << fe_pt
                  << " Face index on boundary is "
                  << Face_index_at_boundary[b][e] << std::endl;
        }
      }
    } // End of if(doc)
 
 
    // Lookup scheme has now been set up
    Lookup_for_elements_next_boundary_is_setup = true;
 
  } // End of setup_boundary_element_info()

References b, oomph::Mesh::Boundary_element_pt, oomph::FiniteElement::dim(), e(), oomph::Mesh::Face_index_at_boundary, oomph::Mesh::finite_element_pt(), oomph::Node::get_boundaries_pt(), oomph::Mesh::Lookup_for_elements_next_boundary_is_setup, n, oomph::Mesh::nboundary(), oomph::Mesh::nelement(), oomph::FiniteElement::nnode_1d(), oomph::FiniteElement::node_pt(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and oomph::Global_string_for_annotation::string().

---

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

• line_mesh.h
• line_mesh.cc