caribou::geometry::RectangularQuad< _Dimension, Linear > Struct Template Reference

Detailed Description

template<UNSIGNED_INTEGER_TYPE _Dimension>
struct caribou::geometry::RectangularQuad< _Dimension, Linear >

Linear Rectangular Quad.

*        v
*        ^
*        |
*  3-----------2
*  |     |     |
*  |     |     |
*  |     +---- | --> u
*  |           |
*  |           |
*  0-----------1
* 

Template Parameters

_Dimension

The world coordinates dimension

#include <RectangularQuad.h>

Inheritance diagram for caribou::geometry::RectangularQuad< _Dimension, Linear >:

Public Types
using	Base = BaseRectangularQuad< RectangularQuad< _Dimension, Linear > >
using	LocalCoordinates = typename Base::LocalCoordinates
using	WorldCoordinates = typename Base::WorldCoordinates
using	GaussNode = typename Base::GaussNode
template<UNSIGNED_INTEGER_TYPE Dim>
using	Vector = typename Base::template Vector< Dim >
template<UNSIGNED_INTEGER_TYPE Rows, UNSIGNED_INTEGER_TYPE Cols>
using	Matrix = typename Base::template Matrix< Rows, Cols >
using	Size = typename Base::Size
using	Rotation = typename Base::Rotation
Public Types inherited from caribou::geometry::BaseRectangularQuad< RectangularQuad< _Dimension, Linear > >
using	Base = Element< RectangularQuad< _Dimension, Linear > >
using	LocalCoordinates = typename Base::LocalCoordinates
using	WorldCoordinates = typename Base::WorldCoordinates
using	GaussNode = typename Base::GaussNode
using	Vector = typename Base::template Vector< Dim >
using	Matrix = typename Base::template Matrix< Rows, Cols >
using	Size = Vector< CanonicalDimension >
using	Rotation = Matrix< Dimension, Dimension >
Public Types inherited from caribou::geometry::Element< RectangularQuad< _Dimension, Linear > >
using	Scalar = FLOATING_POINT_TYPE
using	Vector = Eigen::Matrix< Scalar, Dim, 1 >
using	Matrix = Eigen::Matrix< Scalar, Rows, Cols, Options >
using	MatrixI = Eigen::Matrix< Scalar, Rows, Cols, Options >
using	LocalCoordinates = Vector< CanonicalDimension >
using	WorldCoordinates = Vector< Dimension >

Public Member Functions
	RectangularQuad (const Quad< Dimension, Linear > &quad)
template<typename EigenType , REQUIRES(EigenType::RowsAtCompileTime==NumberOfNodesAtCompileTime) >
	RectangularQuad (Eigen::EigenBase< EigenType > &nodes)
	Constructor from an Eigen matrix containing the positions of the quad's nodes.
template<typename EigenType , REQUIRES(EigenType::RowsAtCompileTime==NumberOfNodesAtCompileTime) >
	RectangularQuad (const Eigen::EigenBase< EigenType > &nodes)
	Constructor from an Eigen matrix containing the positions of the quad's nodes.
Public Member Functions inherited from caribou::geometry::BaseRectangularQuad< RectangularQuad< _Dimension, Linear > >
	BaseRectangularQuad ()
	Default empty constructor.
	BaseRectangularQuad (WorldCoordinates center)
	Constructor by specifying the center point.
	BaseRectangularQuad (WorldCoordinates center, Size H)
	Constructor by specifying the center point and the size (hx, hy, hz)
	BaseRectangularQuad (WorldCoordinates center, Rotation R)
	Constructor by specifying the center point and the rotation.
	BaseRectangularQuad (WorldCoordinates center, Size H, Rotation R)
	Constructor by specifying the center point, the size (hx, hy, hz) and the rotation.
auto	edges () const
	Get the list of node indices of the edges. More...
auto	rotation () const -> const Rotation &
	Get the rotation frame of the quad.
auto	size () const -> const Size &
	Get the size (hx, hy) of the quad.
auto	T (const LocalCoordinates &coordinates) const -> WorldCoordinates
	Compute the transformation of a local position {u,v} to its world position {x,y[ ,z]}.
Public Member Functions inherited from caribou::geometry::Element< RectangularQuad< _Dimension, Linear > >
auto	number_of_nodes () const -> UNSIGNED_INTEGER_TYPE
	Get the number of nodes in the element.
auto	number_of_gauss_nodes () const -> UNSIGNED_INTEGER_TYPE
	Get the number of gauss nodes in the element.
auto	node (const UNSIGNED_INTEGER_TYPE &index) const
	Get the Node at given index.
auto	nodes () const
	Get the set of nodes.
auto	gauss_node (const UNSIGNED_INTEGER_TYPE &index) const -> const GaussNode &
	Get the gauss node at given index.
auto	gauss_nodes () const -> const std::vector< GaussNode > &
	Get the set of gauss nodes.
auto	number_of_boundary_elements () const
	Get the number of boundary elements (ex. More...
auto	boundary_elements_node_indices () const -> const auto &
	Get the list of node indices of the boundary elements. More...
auto	boundary_element (const UNSIGNED_INTEGER_TYPE &boundary_id) const
	Construct and return the given boundary element. More...
auto	L (const LocalCoordinates &xi) const -> Vector< NumberOfNodesAtCompileTime >
	Get the Lagrange polynomial values evaluated at local coordinates xi w.r.t each element's interpolation nodes. More...
auto	dL (const LocalCoordinates &xi) const -> Matrix< NumberOfNodesAtCompileTime, CanonicalDimension >
	Get the Lagrange polynomial derivatives w.r.t the local frame {dL/du} evaluated at local coordinates {u} w.r.t each segment's interpolation nodes. More...
auto	center () const -> WorldCoordinates
	Get the position at the center of the element.
auto	world_coordinates (const LocalCoordinates &coordinates) const -> WorldCoordinates
	Get the world coordinates of a point from its local coordinates.
auto	local_coordinates (const WorldCoordinates &coordinates) const -> LocalCoordinates
	Get the local coordinates of a point from its world coordinates by doing a set of Newton-Raphson iterations. More...
auto	local_coordinates (const WorldCoordinates &coordinates, const LocalCoordinates &starting_point, const FLOATING_POINT_TYPE &residual_tolerance, const UNSIGNED_INTEGER_TYPE &maximum_number_of_iterations) const -> LocalCoordinates
	Get the local coordinates of a point from its world coordinates by doing a set of Newton-Raphson iterations. More...
auto	contains_local (const LocalCoordinates &xi, const FLOATING_POINT_TYPE &eps=1e-10) const -> bool
	Return true if the element contains the point located at the given local coordinates. More...
auto	interpolate (const LocalCoordinates &coordinates, const Eigen::MatrixBase< MatrixType > &values) const
	Interpolate a value at local coordinates from the given interpolation node values. More...
auto	jacobian (const LocalCoordinates &coordinates) const -> Matrix< Dimension, CanonicalDimension >
	Compute the Jacobian matrix of the transformation T(xi)-> x evaluated at local coordinates xi. More...

Static Public Attributes
static constexpr auto	CanonicalDimension = Base::CanonicalDimension
static constexpr auto	Dimension = Base::Dimension
static constexpr auto	NumberOfNodesAtCompileTime = Base::NumberOfNodesAtCompileTime
static constexpr auto	NumberOfGaussNodesAtCompileTime = Base::NumberOfGaussNodesAtCompileTime
static constexpr auto	canonical_nodes = Quad<Dimension, Linear>::canonical_nodes
Static Public Attributes inherited from caribou::geometry::BaseRectangularQuad< RectangularQuad< _Dimension, Linear > >
static constexpr auto	CanonicalDimension
static constexpr auto	Dimension
static constexpr auto	NumberOfNodesAtCompileTime
static constexpr auto	NumberOfGaussNodesAtCompileTime
Static Public Attributes inherited from caribou::geometry::Element< RectangularQuad< _Dimension, Linear > >
static constexpr auto	CanonicalDimension
static constexpr auto	Dimension
static constexpr auto	NumberOfNodesAtCompileTime
static constexpr auto	NumberOfGaussNodesAtCompileTime

Friends
struct	Element< RectangularQuad< _Dimension, Linear > >
struct	BaseQuad< RectangularQuad< _Dimension, Linear > >

Additional Inherited Members
Protected Attributes inherited from caribou::geometry::BaseRectangularQuad< RectangularQuad< _Dimension, Linear > >
WorldCoordinates	p_center
	Position of the center point of the quad.
Size	p_H
	Size of the quad {hx, hy}.
Rotation	p_R
	Rotation matrix (a.k.a. the local coordinates frame) at the center of the quad.

---

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

• /home/jnbrunet/sources/caribou/src/Geometry/RectangularQuad.h