Segment< SPD > Class Template Reference
Segment.h: a line segment DG++. More...
#include <Segment.h>
Public Member Functions | |
| Segment (const std::vector< double > globalCoordVec, const std::vector< GlobalNodalIndex > &connectivity) | |
| virtual | ~Segment () |
| Segment (const Segment< SPD > &that) | |
| virtual Segment< SPD > * | clone () const |
| const size_t | getNumVertices () const |
| const std::string | getPolytopeName () const |
| const size_t | getParametricDimension () const |
| Number of dimensions in parametric configuration. | |
| const size_t | getEmbeddingDimension () const |
| Number of dimensions in the real configuration. | |
| void | map (const double *X, double *Y) const |
| void | dMap (const double *X, double *DY, double &Jac) const |
| size_t | getNumFaces () const |
| Number of faces the polytope has. | |
| ElementGeometry * | getFaceGeometry (size_t e) const |
| const double | getInRadius (void) const |
| Computes the Inner radius of the ElementGeometry object. | |
| const double | getOutRadius (void) const |
| Computes the Outer radius of the ElementGeometry object. | |
| virtual void | computeNormal (size_t e, std::vector< double > &vNormal) const |
| Compute external normal for a face. | |
Detailed Description
template<size_t SPD>
class Segment< SPD >
Segment.h: a line segment DG++.
Created by Adrian Lew on 10/7/06.
Copyright (c) 2006 Adrian Lew
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Segment: Geometry of straight segments A Segment is:
1) A set of indices that describe the connectivity of the segment, properly oriented. The coordinates are not stored in the element but wherever the application decides
2) An affine map from a one-dimensional segment (parametric configuration) with length 1 to the convex hull of the two vertices. Segments embedded in two- and three-dimensional space are hence easily handled.
The parametric configuration is the segment (0,1).
The parametric coordinate used is the distance to 0.
- Warning:
- Neither map nor dMap check for bounds of their array arguments
Constructor & Destructor Documentation
| Segment< SPD >::Segment | ( | const std::vector< double > | globalCoordVec, | |
| const std::vector< GlobalNodalIndex > & | connectivity | |||
| ) | [inline] |
Member Function Documentation
Implements ElementGeometry.
| virtual void Segment< SPD >::computeNormal | ( | size_t | e, | |
| std::vector< double > & | vNormal | |||
| ) | const [inline, virtual] |
Compute external normal for a face.
- Parameters:
-
e,: face number for which the normal is desired vNormal,: output of the three Cartesian components of the normal vector
Implements ElementGeometry.
| void Segment< SPD >::dMap | ( | const double * | X, | |
| double * | DY, | |||
| double & | Jac | |||
| ) | const [inline, virtual] |
- Parameters:
-
X first parametric coordinate DY Output the derivative of the map Jac Output the jacobian of the map
Implements ElementGeometry.
| const size_t Segment< SPD >::getEmbeddingDimension | ( | ) | const [inline, virtual] |
Number of dimensions in the real configuration.
Implements ElementGeometry.
| ElementGeometry* Segment< SPD >::getFaceGeometry | ( | size_t | e | ) | const [inline, virtual] |
- Warning:
- not implemented
Implements ElementGeometry.
| const double Segment< SPD >::getInRadius | ( | void | ) | const [inline, virtual] |
Computes the Inner radius of the ElementGeometry object.
This is defined as the radius of the largest sphere that can be fit inside the polytope.
Implements ElementGeometry.
| size_t Segment< SPD >::getNumFaces | ( | ) | const [inline, virtual] |
Number of faces the polytope has.
Implements ElementGeometry.
| const size_t Segment< SPD >::getNumVertices | ( | ) | const [inline, virtual] |
- Returns:
- number of vertices
Implements ElementGeometry.
| const double Segment< SPD >::getOutRadius | ( | void | ) | const [inline, virtual] |
Computes the Outer radius of the ElementGeometry object.
This is defined as the radius of the smallest sphere that contains the object.
Implements ElementGeometry.
| const size_t Segment< SPD >::getParametricDimension | ( | ) | const [inline, virtual] |
Number of dimensions in parametric configuration.
Implements ElementGeometry.
| const std::string Segment< SPD >::getPolytopeName | ( | ) | const [inline, virtual] |
- Returns:
- Name of type of polytope.
Implements ElementGeometry.
| void Segment< SPD >::map | ( | const double * | X, | |
| double * | Y | |||
| ) | const [inline, virtual] |
- Parameters:
-
X first parametric coordinate Y Output the result of the map
Implements ElementGeometry.
The documentation for this class was generated from the following file:
