Class defining a polyline for use in Triangle Mesh generation. More...

#include <unstructured_two_d_mesh_geometry_base.h>

Inheritance diagram for oomph::TriangleMeshPolyLine:

Public Member Functions
	TriangleMeshPolyLine (const Vector< Vector< double >> &vertex_coordinate, const unsigned &boundary_id, const unsigned &boundary_chunk=0)

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

unsigned	nvertex () const
	Number of vertices. More...

unsigned	nsegment () const
	Number of segments. More...

unsigned	boundary_id () const
	Boundary id. More...

unsigned	boundary_chunk () const

Vector< double >	vertex_coordinate (const unsigned &i) const
	Coordinate vector of i-th vertex (const version) More...

Vector< double > &	vertex_coordinate (const unsigned &i)
	Coordinate vector of i-th vertex. More...

void	initial_vertex_coordinate (Vector< double > &vertex)
	Get first vertex coordinates. More...

void	final_vertex_coordinate (Vector< double > &vertex)
	Get last vertex coordinates. More...

void	output (std::ostream &outfile, const unsigned &n_sample=50)
	Output the polyline – n_sample is ignored. More...

void	reverse ()

Public Member Functions inherited from oomph::TriangleMeshCurveSection
	TriangleMeshCurveSection ()
	Empty constructor. Initialises the curve section as non connected. More...

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

void	enable_refinement_tolerance (const double &tolerance=0.08)

void	set_refinement_tolerance (const double &tolerance)

double	refinement_tolerance ()

void	disable_refinement_tolerance ()
	Disable refinement of curve section. More...

void	enable_unrefinement_tolerance (const double &tolerance=0.04)

void	set_unrefinement_tolerance (const double &tolerance)

double	unrefinement_tolerance ()

void	disable_unrefinement_tolerance ()
	Disable unrefinement of curve sections. More...

void	set_maximum_length (const double &maximum_length)

void	disable_use_maximum_length ()

double	maximum_length ()
	Gets access to the maximum length variable. More...

void	connect_initial_vertex_to_polyline (TriangleMeshPolyLine *polyline_pt, const unsigned &vertex_number, const double &tolerance_for_connection=1.0e-14)

void	connect_final_vertex_to_polyline (TriangleMeshPolyLine *polyline_pt, const unsigned &vertex_number, const double &tolerance_for_connection=1.0e-14)

void	connect_initial_vertex_to_curviline (TriangleMeshCurviLine *curviline_pt, const double &s_value, const double &tolerance_for_connection=1.0e-14)

void	connect_final_vertex_to_curviline (TriangleMeshCurviLine *curviline_pt, const double &s_value, const double &tolerance_for_connection=1.0e-14)

bool	is_initial_vertex_connected () const
	Test whether initial vertex is connected or not. More...

void	set_initial_vertex_connected ()
	Sets the initial vertex as connected. More...

void	unset_initial_vertex_connected ()
	Sets the initial vertex as non connected. More...

void	suspend_initial_vertex_connected ()

void	resume_initial_vertex_connected ()

bool	is_final_vertex_connected () const
	Test whether final vertex is connected or not. More...

void	set_final_vertex_connected ()
	Sets the final vertex as connected. More...

void	unset_final_vertex_connected ()
	Sets the final vertex as non connected. More...

void	suspend_final_vertex_connected ()

void	resume_final_vertex_connected ()

unsigned	initial_vertex_connected_bnd_id () const
	Gets the id to which the initial end is connected. More...

unsigned &	initial_vertex_connected_bnd_id ()
	Sets the id to which the initial end is connected. More...

unsigned	initial_vertex_connected_n_vertex () const
	Gets the vertex number to which the initial end is connected. More...

unsigned &	initial_vertex_connected_n_vertex ()
	Sets the vertex number to which the initial end is connected. More...

unsigned	initial_vertex_connected_n_chunk () const
	Gets the boundary chunk to which the initial end is connected. More...

unsigned &	initial_vertex_connected_n_chunk ()
	Sets the boundary chunk to which the initial end is connected. More...

unsigned	final_vertex_connected_bnd_id () const
	Gets the id to which the final end is connected. More...

unsigned &	final_vertex_connected_bnd_id ()
	Sets the id to which the final end is connected. More...

unsigned	final_vertex_connected_n_vertex () const
	Sets the vertex number to which the final end is connected. More...

unsigned &	final_vertex_connected_n_vertex ()
	Gets the vertex number to which the final end is connected. More...

unsigned	final_vertex_connected_n_chunk () const
	Gets the boundary chunk to which the final end is connected. More...

unsigned &	final_vertex_connected_n_chunk ()
	Sets the boundary chunk to which the final end is connected. More...

bool	is_initial_vertex_connected_to_curviline () const
	Test whether the initial vertex is connected to a curviline. More...

void	set_initial_vertex_connected_to_curviline ()
	Sets the initial vertex as connected to a curviline. More...

void	unset_initial_vertex_connected_to_curviline ()
	Sets the initial vertex as non connected to a curviline. More...

bool	is_final_vertex_connected_to_curviline () const
	Test whether the final vertex is connected to a curviline. More...

void	set_final_vertex_connected_to_curviline ()
	Sets the final vertex as connected to a curviline. More...

void	unset_final_vertex_connected_to_curviline ()
	Sets the final vertex as non connected to a curviline. More...

double	initial_s_connection_value () const
	Gets the s value to which the initial end is connected. More...

double &	initial_s_connection_value ()
	Sets the s value to which the initial end is connected. More...

double	final_s_connection_value () const
	Gets the s value to which the final end is connected. More...

double &	final_s_connection_value ()
	Sets the s value to which the final end is connected. More...

double	tolerance_for_s_connection () const

double &	tolerance_for_s_connection ()

Private Attributes
Vector< Vector< double > >	Vertex_coordinate
	Vector of Vector of vertex coordinates. More...

unsigned	Boundary_id
	Boundary ID. More...

unsigned	Boundary_chunk

Additional Inherited Members
Protected Attributes inherited from oomph::TriangleMeshCurveSection
bool	Initial_vertex_connected

bool	Final_vertex_connected

bool	Initial_vertex_connected_suspended

bool	Final_vertex_connected_suspended

unsigned	Initial_vertex_connected_bnd_id
	Stores the id to which the initial end is connected. More...

unsigned	Initial_vertex_connected_n_vertex

unsigned	Initial_vertex_connected_n_chunk

unsigned	Final_vertex_connected_bnd_id
	Stores the id to which the initial end is connected. More...

unsigned	Final_vertex_connected_n_vertex

unsigned	Final_vertex_connected_n_chunk

bool	Initial_vertex_connected_to_curviline
	States if the initial vertex is connected to a curviline. More...

bool	Final_vertex_connected_to_curviline
	States if the final vertex is connected to a curviline. More...

double	Initial_s_connection_value

double	Final_s_connection_value

double	Tolerance_for_s_connection
	Tolerance used for connecting the ends to a curviline. More...

Detailed Description

Class defining a polyline for use in Triangle Mesh generation.

Constructor & Destructor Documentation

◆ TriangleMeshPolyLine()

oomph::TriangleMeshPolyLine::TriangleMeshPolyLine	(	const Vector< Vector< double >> &	vertex_coordinate,
		const unsigned &	boundary_id,
		const unsigned &	boundary_chunk = `0`
	)

inline

Constructor: Takes vectors of vertex coordinates in order Also allows the optional specification of a boundary ID – useful in a mesh generation context. If not specified it defaults to zero.

       : TriangleMeshCurveSection(),
         Vertex_coordinate(vertex_coordinate),
         Boundary_id(boundary_id),
         Boundary_chunk(boundary_chunk)
     {
 #ifdef PARANOID
       unsigned nvert = Vertex_coordinate.size();
       for (unsigned i = 0; i < nvert; i++)
       {
         if (Vertex_coordinate[i].size() != 2)
         {
           std::ostringstream error_stream;
           error_stream << "TriangleMeshPolyLine should only be used in 2D!\n"
                        << "Your Vector of coordinates, contains data for "
                        << Vertex_coordinate[i].size()
                        << "-dimensional coordinates." << std::endl;
           throw OomphLibError(error_stream.str(),
                               OOMPH_CURRENT_FUNCTION,
                               OOMPH_EXCEPTION_LOCATION);
         }
       }
 #endif
     }

References i, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, size, and Vertex_coordinate.

◆ ~TriangleMeshPolyLine()

virtual oomph::TriangleMeshPolyLine::~TriangleMeshPolyLine ( )

inlinevirtual

Empty destructor.

901 {}

Member Function Documentation

◆ boundary_chunk()

unsigned oomph::TriangleMeshPolyLine::boundary_chunk ( ) const

inlinevirtual

Boundary chunk (Used when a boundary is represented by more than one polyline

Implements oomph::TriangleMeshCurveSection.

     {
       return Boundary_chunk;
     }

References Boundary_chunk.

Referenced by oomph::TriangleMeshCurveSection::connect_final_vertex_to_polyline(), and oomph::TriangleMeshCurveSection::connect_initial_vertex_to_polyline().

◆ boundary_id()

unsigned oomph::TriangleMeshPolyLine::boundary_id ( ) const

inlinevirtual

Boundary id.

Implements oomph::TriangleMeshCurveSection.

     {
       return Boundary_id;
     }

References Boundary_id.

Referenced by oomph::TriangleMeshCurveSection::connect_final_vertex_to_polyline(), and oomph::TriangleMeshCurveSection::connect_initial_vertex_to_polyline().

◆ final_vertex_coordinate()

void oomph::TriangleMeshPolyLine::final_vertex_coordinate ( Vector< double > & vertex )

inlinevirtual

Get last vertex coordinates.

Implements oomph::TriangleMeshCurveSection.

     {
       vertex = Vertex_coordinate[nvertex() - 1];
     }

References nvertex(), and Vertex_coordinate.

◆ initial_vertex_coordinate()

void oomph::TriangleMeshPolyLine::initial_vertex_coordinate ( Vector< double > & vertex )

inlinevirtual

Get first vertex coordinates.

Implements oomph::TriangleMeshCurveSection.

     {
       vertex = Vertex_coordinate[0];
     }

References Vertex_coordinate.

◆ nsegment()

unsigned oomph::TriangleMeshPolyLine::nsegment ( ) const

inlinevirtual

Number of segments.

Implements oomph::TriangleMeshCurveSection.

     {
       return Vertex_coordinate.size() - 1;
     }

References Vertex_coordinate.

◆ nvertex()

unsigned oomph::TriangleMeshPolyLine::nvertex ( ) const

inlinevirtual

Number of vertices.

Implements oomph::TriangleMeshCurveSection.

     {
       return Vertex_coordinate.size();
     }

References Vertex_coordinate.

Referenced by oomph::ImmersedRigidBodyTriangleMeshPolygon::assign_zeta(), oomph::TriangleMeshCurveSection::connect_final_vertex_to_polyline(), oomph::TriangleMeshCurveSection::connect_initial_vertex_to_polyline(), final_vertex_coordinate(), oomph::UnstructuredTwoDMeshGeometryBase::get_connected_vertex_number_on_destination_polyline(), oomph::ImmersedRigidBodyTriangleMeshPolygon::get_initial_position(), oomph::ImmersedRigidBodyTriangleMeshPolygon::reset_reference_configuration(), oomph::TriangleMeshClosedCurve::TriangleMeshClosedCurve(), oomph::TriangleMeshOpenCurve::TriangleMeshOpenCurve(), and oomph::TriangleMeshPolygon::TriangleMeshPolygon().

◆ output()

void oomph::TriangleMeshPolyLine::output	(	std::ostream &	outfile,
		const unsigned &	n_sample = `50`
	)

inlinevirtual

Output the polyline – n_sample is ignored.

Implements oomph::TriangleMeshCurveSection.

     {
       outfile << "ZONE T=\"TriangleMeshPolyLine with boundary ID" << Boundary_id
               << "\"" << std::endl;
       unsigned nvert = Vertex_coordinate.size();
       for (unsigned i = 0; i < nvert; i++)
       {
         outfile << Vertex_coordinate[i][0] << " " << Vertex_coordinate[i][1]
                 << std::endl;
       }
     }

References Boundary_id, i, and Vertex_coordinate.

◆ reverse()

void oomph::TriangleMeshPolyLine::reverse ( )

inline

Reverse the polyline, this includes the connection information and the vertices order

     {
       // Do the reversing of the connection information
  
       // Is there a connection to the initial vertex
       const bool initial_connection = is_initial_vertex_connected();
  
       // Is there a connection to the initial vertex
       const bool final_connection = is_final_vertex_connected();
  
       // If there are any connection at the ends that info. needs to be
       // reversed
       if (initial_connection || final_connection)
       {
         // Backup the connection information
  
         // -------------------------------------------------------------------
         // Backup the initial vertex connection information
         // The boundary id
         const unsigned backup_initial_vertex_connected_bnd_id =
           initial_vertex_connected_bnd_id();
         // The chunk number
         const unsigned backup_initial_vertex_connected_chunk =
           initial_vertex_connected_n_chunk();
         // The vertex number
         const unsigned backup_initial_vertex_connected_n_vertex =
           initial_vertex_connected_n_vertex();
         // Is it connected to a curviline
         const bool backup_initial_vertex_connected_to_curviline =
           is_initial_vertex_connected_to_curviline();
         // The s value for the curviline connection
         const double backup_initial_s_connection = initial_s_connection_value();
         // The tolerance
         const double backup_initial_s_tolerance = tolerance_for_s_connection();
  
         // -------------------------------------------------------------------
         // Backup the final vertex connection information
         // The boundary id
         const unsigned backup_final_vertex_connected_bnd_id =
           final_vertex_connected_bnd_id();
         // The chunk number
         const unsigned backup_final_vertex_connected_chunk =
           final_vertex_connected_n_chunk();
         // The vertex number
         const unsigned backup_final_vertex_connected_n_vertex =
           final_vertex_connected_n_vertex();
         // Is it connected to a curviline
         const bool backup_final_vertex_connected_to_curviline =
           is_final_vertex_connected_to_curviline();
         // The s value for the curviline connection
         const double backup_final_s_connection = final_s_connection_value();
         // The tolerance
         const double backup_final_s_tolerance = tolerance_for_s_connection();
         // -------------------------------------------------------------------
  
         // Disconnect the polyline
  
         // Disconnect the initial vertex
         unset_initial_vertex_connected();
         unset_initial_vertex_connected_to_curviline();
  
         // Disconnect the final vertex
         unset_final_vertex_connected();
         unset_final_vertex_connected_to_curviline();
  
         // Now reconnected but in inverted order
         if (initial_connection)
         {
           // Set the final vertex as connected
           set_final_vertex_connected();
           // Copy the boundary id
           final_vertex_connected_bnd_id() =
             backup_initial_vertex_connected_bnd_id;
           // Copy the chunk number
           final_vertex_connected_n_chunk() =
             backup_initial_vertex_connected_chunk;
           // Copy the vertex number
           final_vertex_connected_n_vertex() =
             backup_initial_vertex_connected_n_vertex;
           // Is it connected to a curviline
           if (backup_initial_vertex_connected_to_curviline)
           {
             // Set the final vertex as connected to curviline
             set_final_vertex_connected_to_curviline();
             // Copy the s value to connected
             final_s_connection_value() = backup_initial_s_connection;
             // Copy the tolerance
             tolerance_for_s_connection() = backup_initial_s_tolerance;
           } // if (backup_initial_vertex_connected_to_curviline)
  
         } // if (initial_connection)
  
         if (final_connection)
         {
           // Set the initial vertex as connected
           set_initial_vertex_connected();
           // Copy the boundary id
           initial_vertex_connected_bnd_id() =
             backup_final_vertex_connected_bnd_id;
           // Copy the chunk number
           initial_vertex_connected_n_chunk() =
             backup_final_vertex_connected_chunk;
           // Copy the vertex number
           initial_vertex_connected_n_vertex() =
             backup_final_vertex_connected_n_vertex;
           // Is it connected to a curviline
           if (backup_final_vertex_connected_to_curviline)
           {
             // Set the initial vertex as connected to curviline
             set_initial_vertex_connected_to_curviline();
             // Copy the s value to connected
             initial_s_connection_value() = backup_final_s_connection;
             // Copy the tolerance
             tolerance_for_s_connection() = backup_final_s_tolerance;
           } // if (backup_final_vertex_connected_to_curviline)
  
         } // if (final_connection)
  
       } // if (initial_connection || final_connection)
  
       // Do the reversing of the vertices
       std::reverse(Vertex_coordinate.begin(), Vertex_coordinate.end());
     }

◆ vertex_coordinate() [1/2]

Vector<double>& oomph::TriangleMeshPolyLine::vertex_coordinate ( const unsigned & i )

inline

Coordinate vector of i-th vertex.

     {
       return Vertex_coordinate[i];
     }

References i, and Vertex_coordinate.

◆ vertex_coordinate() [2/2]

Vector<double> oomph::TriangleMeshPolyLine::vertex_coordinate ( const unsigned & i ) const

inline

Coordinate vector of i-th vertex (const version)

     {
       return Vertex_coordinate[i];
     }

References i, and Vertex_coordinate.

Referenced by oomph::ImmersedRigidBodyTriangleMeshPolygon::assign_zeta(), oomph::TriangleMeshCurveSection::connect_final_vertex_to_polyline(), oomph::TriangleMeshCurveSection::connect_initial_vertex_to_polyline(), oomph::UnstructuredTwoDMeshGeometryBase::get_connected_vertex_number_on_destination_polyline(), oomph::ImmersedRigidBodyTriangleMeshPolygon::get_initial_position(), oomph::ImmersedRigidBodyTriangleMeshPolygon::ImmersedRigidBodyTriangleMeshPolygon(), oomph::ImmersedRigidBodyTriangleMeshPolygon::reset_reference_configuration(), oomph::TriangleMeshClosedCurve::TriangleMeshClosedCurve(), oomph::TriangleMeshOpenCurve::TriangleMeshOpenCurve(), and oomph::TriangleMeshPolygon::TriangleMeshPolygon().

Member Data Documentation

◆ Boundary_chunk

unsigned oomph::TriangleMeshPolyLine::Boundary_chunk

private

Boundary chunk (Used when a boundary is represented by more than one polyline

Referenced by boundary_chunk().

◆ Boundary_id

unsigned oomph::TriangleMeshPolyLine::Boundary_id

private

Boundary ID.

Referenced by boundary_id(), and output().

◆ Vertex_coordinate

Vector<Vector<double> > oomph::TriangleMeshPolyLine::Vertex_coordinate

private

Vector of Vector of vertex coordinates.

Referenced by final_vertex_coordinate(), initial_vertex_coordinate(), nsegment(), nvertex(), output(), reverse(), TriangleMeshPolyLine(), and vertex_coordinate().

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

unstructured_two_d_mesh_geometry_base.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TriangleMeshPolyLine()

◆ ~TriangleMeshPolyLine()

Member Function Documentation

◆ boundary_chunk()

◆ boundary_id()

◆ final_vertex_coordinate()

◆ initial_vertex_coordinate()

◆ nsegment()

◆ nvertex()

◆ output()

◆ reverse()

◆ vertex_coordinate() [1/2]

◆ vertex_coordinate() [2/2]

Member Data Documentation

◆ Boundary_chunk

◆ Boundary_id

◆ Vertex_coordinate