MOAB: Mesh Oriented datABase  (version 5.2.1)
MBMesquite::LinearPrism Class Reference

Linear mapping function for a prism element. More...

#include <LinearPrism.hpp>

+ Inheritance diagram for MBMesquite::LinearPrism:
+ Collaboration diagram for MBMesquite::LinearPrism:

Public Member Functions

virtual EntityTopology element_topology () const
 Get MBMesquite::EntityTopology handled by this mapping function.
virtual int num_nodes () const
 Get number of nodes in the element type.
virtual void coefficients (Sample location, NodeSet nodeset, double *coeff_out, size_t *indices_out, size_t &num_coeff_out, MsqError &err) const
 Mapping Function Coefficients.
virtual void derivatives (Sample location, NodeSet nodeset, size_t *vertex_indices_out, MsqVector< 3 > *d_coeff_d_xi_out, size_t &num_vtx, MsqError &err) const
 Mapping Function Derivatives.
virtual void ideal (Sample location, MsqMatrix< 3, 3 > &jacobian_out, MsqError &err) const
 Get ideal Jacobian matrix.

Detailed Description

Linear mapping function for a prism element.

\( \vec{x}(\vec{\xi})=\sum_{i=1}^6 N_i(\vec{\xi})\vec{x_i} \)

  • \( N_1(\vec{\xi})=(1-\xi)(1-\eta-\zeta) \)
  • \( N_2(\vec{\xi})=(1-\xi)(\eta) \)
  • \( N_3(\vec{\xi})=(1-\xi)(\zeta) \)
  • \( N_4(\vec{\xi})=( \xi)(1-\eta-\zeta) \)
  • \( N_5(\vec{\xi})=( \xi)(\eta) \)
  • \( N_6(\vec{\xi})=( \xi)(\zeta) \) \( \xi,\eta,\zeta \in [0,1] \) \( \eta + \zeta \leq 1 \)

The logical center of the element is at: \( (\xi,\eta,\zeta) = (0,\frac{1}{3},\frac{1}{3}) \)

Definition at line 56 of file LinearPrism.hpp.


Member Function Documentation

void MBMesquite::LinearPrism::coefficients ( Sample  location,
NodeSet  nodeset,
double *  coeff_out,
size_t *  indices_out,
size_t &  num_coeff_out,
MsqError err 
) const [virtual]

Mapping Function Coefficients.

This function returns the list of scalar values ( \(N_i\)'s) resulting from the evaluation of the mapping function coefficient terms \(N_1(\vec{\xi}), N_2(\vec{\xi}), \ldots, N_n(\vec{\xi})\) for a given \(\vec{\xi}\).

Parameters:
locationWhere within the element at which to evaluate the coefficients.
nodesetList of which nodes are present in the element.
coefficients_outThe coefficients ( \(N_i(\vec{\xi})\)) for each vertex in the element.
indices_outThe index ($i$ in $N_i$) for each term in 'coeffs_out'. The assumption is that mapping function implementations will not return zero coefficients. This is not required, but for element types with large numbers of nodes it may have a significant impact on performance.

Implements MBMesquite::MappingFunction.

Definition at line 117 of file LinearPrism.cpp.

References MBMesquite::coefficients_at_corner(), MBMesquite::coefficients_at_mid_edge(), MBMesquite::coefficients_at_mid_elem(), MBMesquite::coefficients_at_mid_face(), MBMesquite::Sample::dimension, MBMesquite::NodeSet::have_any_mid_node(), MBMesquite::MsqError::INVALID_ARG, MSQ_SETERR, MBMesquite::nonlinear_error, MBMesquite::Sample::number, and MBMesquite::MsqError::UNSUPPORTED_ELEMENT.

{
    if( nodeset.have_any_mid_node() )
    {
        MSQ_SETERR( err )( nonlinear_error, MsqError::UNSUPPORTED_ELEMENT );
        return;
    }

    switch( loc.dimension )
    {
        case 0:
            coefficients_at_corner( loc.number, coeff_out, indices_out, num_coeff );
            break;
        case 1:
            coefficients_at_mid_edge( loc.number, coeff_out, indices_out, num_coeff );
            break;
        case 2:
            coefficients_at_mid_face( loc.number, coeff_out, indices_out, num_coeff );
            break;
        case 3:
            coefficients_at_mid_elem( coeff_out, indices_out, num_coeff );
            break;
        default:
            MSQ_SETERR( err )( "Invalid/unsupported logical dimension", MsqError::INVALID_ARG );
    }
}
void MBMesquite::LinearPrism::derivatives ( Sample  location,
NodeSet  nodeset,
size_t *  vertex_indices_out,
MsqVector< 3 > *  d_coeff_d_xi_out,
size_t &  num_vtx,
MsqError err 
) const [virtual]

Mapping Function Derivatives.

This group of methods return the partial derivatives of the mapping function coefficient terms \(\nabla N_1(\vec{\xi}), \nabla N_2(\vec{\xi}), \ldots, \nabla N_n(\vec{\xi})\) evaluated for a given \(\vec{\xi}\), where \(\vec{x_i}\) is a point in \(\mathbf{R}^3\) (i.e. \(x_i,y_i,z_i\)). \(\vec{\xi_i} = \left\{\begin{array}{c}\xi_i\\ \eta_i\\ \end{array}\right\}\) for surface elements and \(\vec{\xi_i} = \left\{\begin{array}{c}\xi_i\\ \eta_i\\ \zeta_i\\ \end{array}\right\}\) for volume elements.

The list of returned partial derivatives may be considered list of elements of a matrix \(\mathbf{D}\) in row major order. For surface elements, \(\mathbf{D}\) is a \(n\times 2\) matrix and for volume elements it is a \(n \times 3\) matrix. Each row of \(\mathbf{D}\) corresponds to one of the coefficient functions \(N_i(\vec{\xi})\) and each column corresponds to one of the components of \(\vec{\xi}\) that the corresponding coefficient function is differentiated with respect to.

\( \mathbf{D} = \left[ \begin{array}{ccc} \frac{\delta N_1}{\delta \xi} & \frac{\delta N_1}{\delta \eta} & \ldots \\ \frac{\delta N_2}{\delta \xi} & \frac{\delta N_2}{\delta \eta} & \ldots \\ \vdots & \vdots & \ddots \end{array} \right]\)

The Jacobian matrix ( \(\mathbf{J}\)) of the mapping function can be calculated as follows. Define a matrix \(\mathbf{X}\) such that each column contains the coordinates of the element nodes.

\( \mathbf{X} = \left[ \begin{array}{ccc} x_1 & x_2 & \ldots \\ y_1 & y_2 & \ldots \\ z_1 & z_2 & \ldots \end{array}\right]\)

The Jacobian matrix is then:

\(\mathbf{J} = \mathbf{X} \times \mathbf{D}\)

\(\mathbf{X}\) is always \(3\times n\), so \(\mathbf{J}\) is either \(3\times 2\) (surface elements) or \(3\times 3\) (volume elements) depending on the dimensions of \(\mathbf{D}\).

If the Jacobian matrix of the mapping function is considered as a function of the element vertex coordinates \(\mathbf{J}(\vec{x_1},\vec{x_2},\ldots)\) with \(\vec{\xi}\) constant, then the gradient of that Jacobian matrix function (with respect to the vertex coordinates) can be obtained from the same output list of partial deravitves.

\(\frac{\delta \mathbf{J}}{\delta x_i} = \left[ \begin{array}{ccc} \frac{\delta N_i}{\delta \xi} & \frac{\delta N_i}{\delta \eta} & \ldots \\ 0 & 0 & \ldots \\ 0 & 0 & \ldots \end{array} \right]\) \(\frac{\delta \mathbf{J}}{\delta y_i} = \left[ \begin{array}{ccc} 0 & 0 & \ldots \\ \frac{\delta N_i}{\delta \xi} & \frac{\delta N_i}{\delta \eta} & \ldots \\ 0 & 0 & \ldots \end{array} \right]\) \(\frac{\delta \mathbf{J}}{\delta z_i} = \left[ \begin{array}{ccc} 0 & 0 & \ldots \\ 0 & 0 & \ldots \\ \frac{\delta N_i}{\delta \xi} & \frac{\delta N_i}{\delta \eta} & \ldots \end{array} \right]\)

Parameters:
locationWhere within the element at which to evaluate the derivatives.
nodesetList of which nodes are present in the element.
vertices_outThe list of vertices for which the corresponding coefficient in the mapping function is non-zero. The vertices are specified by their index in the canonical ordering for an element with all mid-nodes present (i.e. first all the corner nodes, then the mid-edge nodes, ...).
d_coeff_d_xi_outThe mapping function is composed of a series of coefficient functions \(N_i(\vec{\xi})\), one correspoding to the position \(\vec{x_i}\) of each node in the element such that the mapping function is of the form: \(\vec{x}(\vec{\xi})=\sum_{i=1}^n N_i(\vec{\xi})\vec{x_i}\). For each vertex indicated in vertex_indices_out, this list contains the partial derivatives of the cooresponding coefficient function \(N_i\) with respect to each component of \(\vec{\xi}\) in the same order as the corresponding nodes in vertex_indices_out.
num_vtxOutput: The number of vertex indices and derivitive tuples returned in vertices_out and d_coeff_d_xi_out, respectively.

Implements MBMesquite::MappingFunction3D.

Definition at line 388 of file LinearPrism.cpp.

References MBMesquite::derivatives_at_corner(), MBMesquite::derivatives_at_mid_edge(), MBMesquite::derivatives_at_mid_elem(), MBMesquite::derivatives_at_mid_face(), MBMesquite::Sample::dimension, MBMesquite::NodeSet::have_any_mid_node(), MBMesquite::MsqError::INVALID_ARG, MSQ_SETERR, MBMesquite::nonlinear_error, MBMesquite::Sample::number, and MBMesquite::MsqError::UNSUPPORTED_ELEMENT.

{
    if( nodeset.have_any_mid_node() )
    {
        MSQ_SETERR( err )( nonlinear_error, MsqError::UNSUPPORTED_ELEMENT );
        return;
    }

    switch( loc.dimension )
    {
        case 0:
            derivatives_at_corner( loc.number, vertex_indices_out, d_coeff_d_xi_out, num_vtx );
            break;
        case 1:
            derivatives_at_mid_edge( loc.number, vertex_indices_out, d_coeff_d_xi_out, num_vtx );
            break;
        case 2:
            derivatives_at_mid_face( loc.number, vertex_indices_out, d_coeff_d_xi_out, num_vtx );
            break;
        case 3:
            derivatives_at_mid_elem( vertex_indices_out, d_coeff_d_xi_out, num_vtx );
            break;
        default:
            MSQ_SETERR( err )( "Invalid/unsupported logical dimension", MsqError::INVALID_ARG );
    }
}

Get MBMesquite::EntityTopology handled by this mapping function.

Implements MBMesquite::MappingFunction.

Definition at line 41 of file LinearPrism.cpp.

References MBMesquite::PRISM.

{
    return PRISM;
}
void MBMesquite::LinearPrism::ideal ( Sample  location,
MsqMatrix< 3, 3 > &  jacobian_out,
MsqError err 
) const [virtual]

Get ideal Jacobian matrix.

Returns the Jacobian matrix of an ideal element. The orientation of element or corresponding matrix is arbitrary. The "ideal" element should be scaled such the Jacobian (determinant of the Jacobian matrix) is 1.0.

Parameters:
locationWhere within the element at which to evaluate the Jacobian. Typically doesn't matter except for degenerate elements (e.g. pyramid as degenerate hex.)
jacobian_outThe Jacobian of the mapping function at the specified logical location.

Reimplemented from MBMesquite::MappingFunction3D.

Definition at line 416 of file LinearPrism.cpp.

References b.

{
    const double a = 0.52455753171082409;  // 2^(-2/3) * 3^(-1/6)
    const double b = 0.90856029641606983;  // a * sqrt(3) = 1/2 cbrt(6)

    J( 0, 0 ) = 2 * a;
    J( 0, 1 ) = 0.0;
    J( 0, 2 ) = 0.0;
    J( 1, 0 ) = 0.0;
    J( 1, 1 ) = 2 * a;
    J( 1, 2 ) = a;
    J( 2, 0 ) = 0.0;
    J( 2, 1 ) = 0.0;
    J( 2, 2 ) = b;
}
int MBMesquite::LinearPrism::num_nodes ( ) const [virtual]

Get number of nodes in the element type.

Get the number of nodes in the element type that the mapping function implements. It is assumed that the result of this function, in combination with the element topology, is sufficient to determine the element type.

Implements MBMesquite::MappingFunction.

Definition at line 46 of file LinearPrism.cpp.

{
    return 6;
}

List of all members.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines