SlaughterVol2mesh::Vol2meshMeshCriteria Class Reference

A class for storing and accessing mesh criteria data for the Vol2mesh class. The Vol2mesh class relies on instances of this class to store and retrieve the CGAL meshing criteria. Details of these critiera are provided in the CGAL documentation (see link below). There are five criteria, these terms are provided here in order: More...

#include <vol2mesh/vol2mesh_mesh_criteria.h>

List of all members.

Public Member Functions
	Vol2meshMeshCriteria ()
	Default constructor.
	Vol2meshMeshCriteria (vector< double > vec)
	Vector input constructor.
	Vol2meshMeshCriteria (double a, double b, double c, double d, double e)
	Inidividual input constructor.
vector< double >	get_vector ()
	A method for extracting the meshing criteria as vector.
double	get_value (int i)
	A method for extracing a single mesh criteria by index.
void	init (vector< double >)
	Initilization function.
Public Attributes
double	facet_angle
	The CGAL facet angle mesh criteria.
double	facet_size
	The CGAL facet size mesh criteria.
double	facet_distance
	The CGAL facet distance mesh criteria.
double	cell_radius_edge_ratio
	The CGAL cell radius to edge ratio mesh criteria.
double	cell_size
	The CGAL cell size meshing criteria.
int	id
	The subdomain id.

---

Detailed Description

A class for storing and accessing mesh criteria data for the Vol2mesh class. The Vol2mesh class relies on instances of this class to store and retrieve the CGAL meshing criteria. Details of these critiera are provided in the CGAL documentation (see link below). There are five criteria, these terms are provided here in order:

1. facet_angle
2. facet_size
3. facet_distance
4. cell_radius_edge_ratio
5. cell_size

CGAL Documentation:
http://www.cgal.org/Manual/latest/doc_html/cgal_manual/Mesh_3/Chapter_main.html

See also:

Vol2mesh

---

Constructor & Destructor Documentation

SlaughterVol2mesh::Vol2meshMeshCriteria::Vol2meshMeshCriteria

(

)

Default constructor.

Sets all meshing criteria to zero.

See also:

Vol2meshMeshCriteria(vector<double>)

Vol2meshMeshCriteria(double a, double b, double c, double d, double e)

SlaughterVol2mesh::Vol2meshMeshCriteria::Vol2meshMeshCriteria

(

vector< double >

vec

)

Vector input constructor.

Constructor that accepts a vector, the values from the vector are inserted in to the mesh criteria attributes.

Parameters:

vec	A vector of mesh criteria; values must be in order shown in the main class documentation.

See also:

Vol2meshMeshCriteria()

Vol2meshMeshCriteria(double a, double b, double c, double d, double e)

SlaughterVol2mesh::Vol2meshMeshCriteria::Vol2meshMeshCriteria	(	double	a,
		double	b,
		double	c,
		double	d,
		double	e
	)

Inidividual input constructor.

Constructor that accepts a five doubles, the values are inserted in to the mesh criteria attributes in order as listed in order:

Parameters:

a	facet_angle
b	facet_size
c	facet_distance
d	cell_radius_edge_ratio
e	cell_size

See also:

Vol2meshMeshCriteria()

Vol2meshMeshCriteria(vector<double>)

---

Member Function Documentation

double SlaughterVol2mesh::Vol2meshMeshCriteria::get_value

(

int

i

)

A method for extracing a single mesh criteria by index.

Parameters:

i	Index of the desired criteria (0 through 4); criteria ordered as in the main class documentation

Returns:

A double of the desired parameter

vector< double > SlaughterVol2mesh::Vol2meshMeshCriteria::get_vector

(

)

A method for extracting the meshing criteria as vector.

Returns:

A vector containing the five meshing criteria in order as specified in the main class documentation.

void SlaughterVol2mesh::Vol2meshMeshCriteria::init

(

vector< double >

vec

)

Initilization function.

Sets the mesh criteria to the values given in the vector in the same fashion as the vector version of the constructor.

See also:

Vol2meshMeshCriteria(vector<double>)

---

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

• include/vol2mesh/vol2mesh_mesh_criteria.h
• source/vol2mesh/vol2mesh_mesh_criteria.cpp