AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::mint::Lagrange< mint::QUAD > Class Reference

Lagrange Finite Element definition for Bilinear Quadrilateral. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/mint/fem/shape_functions/lagrange/lagrange_quad_4.hpp>

Inheritance diagram for axom::mint::Lagrange< mint::QUAD >:

Static Public Member Functions

static CellType getCellType ()
 
static int getType ()
 
static int getNumDofs ()
 
static int getMaxNewtonIters ()
 
static int getDimension ()
 
static double getMin ()
 
static double getMax ()
 
static void getCenter (double *center)
 
static void getCoords (double *coords)
 
static void computeShape (const double *xr, double *phi)
 
static void computeDerivatives (const double *xr, double *phidot)
 
Generic ShapeFunction API
static CellType cellType ()
 Returns the underlying cell type, e.g., MINT_QUAD, etc. More...
 
static int type ()
 Returns the Finite Element basis family type. More...
 
static int numDofs ()
 Returns the number of degrees of freedom. More...
 
static int maxNewtonIters ()
 Returns the maximum number of iterations for the Newton-Raphson. More...
 
static int dimension ()
 Returns the dimension of the reference element. More...
 
static double min ()
 Returns the min coordinate of the reference element. More...
 
static double max ()
 Returns the max coordinate of the reference element. More...
 
static void center (double *center)
 Returns the center of the reference element. More...
 
static void coords (double *coords)
 Returns the coordinates of the reference element. More...
 
static void evaluate (const double *nc, double *phi)
 Evaluates the ShapeFunction at the given natural coordinates. More...
 
static void derivatives (const double *nc, double *phidot)
 Evaluates the first derivatives of the shape function at the given natural coordinates. More...
 

Detailed Description

Lagrange Finite Element definition for Bilinear Quadrilateral.

*
* quad_4:
*
*   3       2
*   +-------+
*   |       |
*   |       |
*   +-------+
*   0       1
*
* 
See also
ShapeFunction

Member Function Documentation

◆ getCellType()

static CellType axom::mint::Lagrange< mint::QUAD >::getCellType ( )
inlinestatic

References axom::mint::QUAD.

◆ getType()

static int axom::mint::Lagrange< mint::QUAD >::getType ( )
inlinestatic

References MINT_LAGRANGE_BASIS.

◆ getNumDofs()

static int axom::mint::Lagrange< mint::QUAD >::getNumDofs ( )
inlinestatic

◆ getMaxNewtonIters()

static int axom::mint::Lagrange< mint::QUAD >::getMaxNewtonIters ( )
inlinestatic

◆ getDimension()

static int axom::mint::Lagrange< mint::QUAD >::getDimension ( )
inlinestatic

◆ getMin()

static double axom::mint::Lagrange< mint::QUAD >::getMin ( )
inlinestatic

◆ getMax()

static double axom::mint::Lagrange< mint::QUAD >::getMax ( )
inlinestatic

◆ getCenter()

static void axom::mint::Lagrange< mint::QUAD >::getCenter ( double *  center)
inlinestatic

◆ getCoords()

static void axom::mint::Lagrange< mint::QUAD >::getCoords ( double *  coords)
inlinestatic

◆ computeShape()

static void axom::mint::Lagrange< mint::QUAD >::computeShape ( const double *  xr,
double *  phi 
)
inlinestatic

References SLIC_ASSERT.

◆ computeDerivatives()

static void axom::mint::Lagrange< mint::QUAD >::computeDerivatives ( const double *  xr,
double *  phidot 
)
inlinestatic

References SLIC_ASSERT.

◆ cellType()

static CellType axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::cellType ( )
inlinestaticinherited

Returns the underlying cell type, e.g., MINT_QUAD, etc.

Returns
cellType the cell type
See also
CellType.hpp

◆ type()

static int axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::type ( )
inlinestaticinherited

Returns the Finite Element basis family type.

Returns
type the basis function type, e.g., MINT_LAGRANGE_BASIS
See also
FEBasisTypes.hpp

◆ numDofs()

static int axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::numDofs ( )
inlinestaticinherited

Returns the number of degrees of freedom.

Returns
ndofs the number of degrees of freedom
Postcondition
ndofs >= 1

◆ maxNewtonIters()

static int axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::maxNewtonIters ( )
inlinestaticinherited

Returns the maximum number of iterations for the Newton-Raphson.

Returns
N the maximum number of Newton-Raphson iterations

◆ dimension()

static int axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::dimension ( )
inlinestaticinherited

Returns the dimension of the reference element.

Returns
ndims the dimension of the reference element
Postcondition
ndims >= 1

◆ min()

static double axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::min ( )
inlinestaticinherited

Returns the min coordinate of the reference element.

Returns
min the min coordinate of the reference element

◆ max()

static double axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::max ( )
inlinestaticinherited

Returns the max coordinate of the reference element.

Returns
max the max coordinate of the reference element

◆ center()

static void axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::center ( double *  center)
inlinestaticinherited

Returns the center of the reference element.

Parameters
[out]centerbuffer (ndims long) to store the centroid
Precondition
center != nullptr

◆ coords()

static void axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::coords ( double *  coords)
inlinestaticinherited

Returns the coordinates of the reference element.

Parameters
[out]coordsbuffer (ndims*ndofs long) to store the coordinates
Precondition
coords != nullptr
Note
THe coordinates are arranged in column-major flat array layout

◆ evaluate()

static void axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::evaluate ( const double *  nc,
double *  phi 
)
inlinestaticinherited

Evaluates the ShapeFunction at the given natural coordinates.

Parameters
[in]ncnatural coordinates at which to compute the shape functions
[out]phibuffer (ndofs long) to store the shape function.
Precondition
nc != nullptr
phi != nullptr

◆ derivatives()

static void axom::mint::ShapeFunction< Lagrange< mint::QUAD > >::derivatives ( const double *  nc,
double *  phidot 
)
inlinestaticinherited

Evaluates the first derivatives of the shape function at the given natural coordinates.

Parameters
[in]ncnatural coordinates at which to compute the derivatives
[out]phidotbuffer (ndofs*ndims long) to store the derivatives
Precondition
nc != nullptr
phidot != nullptr

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