Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
oomph::Shape Class Reference

A Class for shape functions. In simple cases, the shape functions have only one index that can be thought of as corresponding to the nodal points. In general, however, when quantities and their gradients are interpolated separately, the shape function have two indices: one corresponding to the nodal points, and the other to the "type" of quantity being interpolated: function, derivative, &c The second index can also represent the vector coordinate for vector-valued (Nedelec) shape functions. More...

#include <shape.h>

+ Inheritance diagram for oomph::Shape:

Public Member Functions

 Shape (const unsigned &N)
 Constructor for a single-index set of shape functions. More...
 
 Shape (const unsigned &N, const unsigned &M)
 Constructor for a two-index set of shape functions. More...
 
 Shape (const Shape &shape)=delete
 Broken copy constructor. More...
 
 Shape ()
 Default constructor - just assigns a null pointers and zero index sizes. More...
 
void operator= (const Shape &shape)
 The assignment operator does a shallow copy (resets the pointer to the data) More...
 
void operator= (Shape *const &shape_pt)
 The assignment operator does a shallow copy (resets the pointer to the data) More...
 
 ~Shape ()
 Destructor, clear up the memory allocated by the object. More...
 
void resize (const unsigned &N, const unsigned &M=1)
 Change the size of the storage. More...
 
double & operator[] (const unsigned &i)
 Overload the bracket operator to provide access to values. More...
 
const double & operator[] (const unsigned &i) const
 Overload the bracket operator (const version) More...
 
double & operator() (const unsigned &i)
 Overload the round bracket operator to provide access to values. More...
 
const double & operator() (const unsigned &i) const
 Overload the round bracket operator (const version) More...
 
double & operator() (const unsigned &i, const unsigned &j)
 Overload the round bracket operator, allowing for two indices. More...
 
const double & operator() (const unsigned &i, const unsigned &j) const
 Overload the round bracket operator, allowing for two indices (const version) More...
 
unsigned nindex1 () const
 Return the range of index 1 of the shape function object. More...
 
unsigned nindex2 () const
 Return the range of index 2 of the shape function object. More...
 

Protected Member Functions

void range_check (const unsigned &i, const unsigned &j) const
 Private function that checks whether the index is in range. More...
 

Protected Attributes

double * Psi
 Pointer that addresses the storage that will be used to read and set the shape functions. The shape functions are packed into a flat array of doubles. More...
 
double * Allocated_storage
 Pointer that addresses the storage allocated by the object on construction. This will be the same as Psi if the object is not copied. More...
 
unsigned Index1
 Size of the first index of the shape function. More...
 
unsigned Index2
 Size of the second index of the shape function. More...
 

Detailed Description

A Class for shape functions. In simple cases, the shape functions have only one index that can be thought of as corresponding to the nodal points. In general, however, when quantities and their gradients are interpolated separately, the shape function have two indices: one corresponding to the nodal points, and the other to the "type" of quantity being interpolated: function, derivative, &c The second index can also represent the vector coordinate for vector-valued (Nedelec) shape functions.

The implementation of Shape functions is designed to permit fast copying of entire sets of values by resetting the internal pointer to the data, Psi; functionality that is required, for example, when setting the test functions in Galerkin elements and when reading pre-computed values of the shape functions. In general, we cannot know at construction time whether the pointer to the values will be reset or not and, therefore, whether the storage for values should be allocated by the object. We choose to allocate storage on construction and store an additional pointer Allocated_data that always addresses the storage allocated by the object. If the Psi pointer is reset then this storage will be "wasted", but only for the lifetime of the object. The cost for non-copied Shape functions is one additional pointer.

Definition at line 75 of file shape.h.

Constructor & Destructor Documentation

◆ Shape() [1/4]

oomph::Shape::Shape ( const unsigned &  N)
inline

Constructor for a single-index set of shape functions.

Definition at line 119 of file shape.h.

References Allocated_storage, oomph::QuadTreeNames::N, and Psi.

◆ Shape() [2/4]

oomph::Shape::Shape ( const unsigned &  N,
const unsigned &  M 
)
inline

Constructor for a two-index set of shape functions.

Definition at line 126 of file shape.h.

References Allocated_storage, oomph::QuadTreeNames::N, and Psi.

◆ Shape() [3/4]

oomph::Shape::Shape ( const Shape shape)
delete

Broken copy constructor.

◆ Shape() [4/4]

oomph::Shape::Shape ( )
inline

Default constructor - just assigns a null pointers and zero index sizes.

Definition at line 137 of file shape.h.

◆ ~Shape()

oomph::Shape::~Shape ( )
inline

Destructor, clear up the memory allocated by the object.

Definition at line 182 of file shape.h.

References Allocated_storage.

Member Function Documentation

◆ nindex1()

unsigned oomph::Shape::nindex1 ( ) const
inline

◆ nindex2()

unsigned oomph::Shape::nindex2 ( ) const
inline

◆ operator()() [1/4]

double & oomph::Shape::operator() ( const unsigned &  i)
inline

Overload the round bracket operator to provide access to values.

Definition at line 222 of file shape.h.

References i, Index2, Psi, and range_check().

◆ operator()() [2/4]

const double & oomph::Shape::operator() ( const unsigned &  i) const
inline

Overload the round bracket operator (const version)

Definition at line 231 of file shape.h.

References i, Index2, Psi, and range_check().

◆ operator()() [3/4]

double & oomph::Shape::operator() ( const unsigned &  i,
const unsigned &  j 
)
inline

Overload the round bracket operator, allowing for two indices.

Definition at line 240 of file shape.h.

References i, Index2, Psi, and range_check().

◆ operator()() [4/4]

const double & oomph::Shape::operator() ( const unsigned &  i,
const unsigned &  j 
) const
inline

Overload the round bracket operator, allowing for two indices (const version)

Definition at line 250 of file shape.h.

References i, Index2, Psi, and range_check().

◆ operator=() [1/2]

void oomph::Shape::operator= ( const Shape shape)
inline

The assignment operator does a shallow copy (resets the pointer to the data)

Definition at line 141 of file shape.h.

References Index1, Index2, Psi, and oomph::OneDimHermite::shape().

◆ operator=() [2/2]

void oomph::Shape::operator= ( Shape *const &  shape_pt)
inline

The assignment operator does a shallow copy (resets the pointer to the data)

Definition at line 162 of file shape.h.

References Index1, Index2, and Psi.

◆ operator[]() [1/2]

double & oomph::Shape::operator[] ( const unsigned &  i)
inline

Overload the bracket operator to provide access to values.

Definition at line 204 of file shape.h.

References i, Index2, Psi, and range_check().

◆ operator[]() [2/2]

const double & oomph::Shape::operator[] ( const unsigned &  i) const
inline

Overload the bracket operator (const version)

Definition at line 213 of file shape.h.

References i, Index2, Psi, and range_check().

◆ range_check()

void oomph::Shape::range_check ( const unsigned &  i,
const unsigned &  j 
) const
inlineprotected

Private function that checks whether the index is in range.

Definition at line 95 of file shape.h.

References i, Index1, and Index2.

Referenced by operator()(), and operator[]().

◆ resize()

void oomph::Shape::resize ( const unsigned &  N,
const unsigned &  M = 1 
)
inline

Change the size of the storage.

Definition at line 189 of file shape.h.

References Allocated_storage, Index1, Index2, oomph::QuadTreeNames::N, and Psi.

Member Data Documentation

◆ Allocated_storage

double* oomph::Shape::Allocated_storage
protected

Pointer that addresses the storage allocated by the object on construction. This will be the same as Psi if the object is not copied.

Definition at line 86 of file shape.h.

Referenced by resize(), Shape(), ~Shape(), and oomph::ShapeWithDeepCopy::~ShapeWithDeepCopy().

◆ Index1

unsigned oomph::Shape::Index1
protected

Size of the first index of the shape function.

Definition at line 89 of file shape.h.

Referenced by nindex1(), operator=(), range_check(), resize(), and oomph::ShapeWithDeepCopy::ShapeWithDeepCopy().

◆ Index2

unsigned oomph::Shape::Index2
protected

Size of the second index of the shape function.

Definition at line 92 of file shape.h.

Referenced by nindex2(), operator()(), operator=(), operator[](), range_check(), resize(), and oomph::ShapeWithDeepCopy::ShapeWithDeepCopy().

◆ Psi

double* oomph::Shape::Psi
protected

Pointer that addresses the storage that will be used to read and set the shape functions. The shape functions are packed into a flat array of doubles.

Definition at line 81 of file shape.h.

Referenced by operator()(), operator=(), operator[](), resize(), Shape(), and oomph::ShapeWithDeepCopy::ShapeWithDeepCopy().


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