MoReFEM
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes
MoReFEM::ExtendedUnknown Class Referencefinal

This class encapsulates an unknown in a given finite element space. More...

#include <ExtendedUnknown.hpp>

Collaboration diagram for MoReFEM::ExtendedUnknown:

Public Types

using const_shared_ptr = std::shared_ptr<const ExtendedUnknown>
 Alias to shared pointer to const object.
 
using vector_const_shared_ptr = std::vector<const_shared_ptr>
 Alias to vector of shared pointers.
 

Public Member Functions

const UnknownGetUnknown () const noexcept
 Get the underlying unknown.
 
const Unknown::const_shared_ptrGetUnknownPtr () const noexcept
 Get the underlying unknown.
 
const NumberingSubsetGetNumberingSubset () const noexcept
 Get the underlying numbering subset.
 
const NumberingSubset::const_shared_ptrGetNumberingSubsetPtr () const noexcept
 Get the underlying numbering subset as a smart pointer.
 
const std::string & GetShapeFunctionLabel () const noexcept
 Return the shape function label ('P1', 'Q3', etc...)
 
UnknownNS::Nature GetNature () const noexcept
 Nature of the unknown.
 
Special members.
 ExtendedUnknown (Unknown::const_shared_ptr unknown, NumberingSubset::const_shared_ptr numbering_subset, const std::string &shape_function_label)
 Constructor.
 
 ~ExtendedUnknown ()=default
 Destructor.
 
 ExtendedUnknown (const ExtendedUnknown &rhs)=delete
 The copy constructor.
 
 ExtendedUnknown (ExtendedUnknown &&rhs)=delete
 The move constructor.
 
ExtendedUnknownoperator= (const ExtendedUnknown &rhs)=delete
 The (copy) operator=.
 
ExtendedUnknownoperator= (ExtendedUnknown &&rhs)=delete
 The (move) operator=.
 

Private Attributes

Unknown::const_shared_ptr unknown_
 Unknown considered.
 
NumberingSubset::const_shared_ptr numbering_subset_
 Numbering subset considered.
 
const std::string & shape_function_label_
 Shape function label.
 

Detailed Description

This class encapsulates an unknown in a given finite element space.

In one finite element space unknown is related to exactly one numbering subset and exactly shape function label.

Constructor & Destructor Documentation

◆ ExtendedUnknown() [1/3]

MoReFEM::ExtendedUnknown::ExtendedUnknown ( Unknown::const_shared_ptr unknown,
NumberingSubset::const_shared_ptr numbering_subset,
const std::string & shape_function_label )
explicit

Constructor.

Parameters
[in]unknownPointer to the Unknown for which ExtendedUnknown is created.
[in]numbering_subsetPointer to the NumberingSubset for which ExtendedUnknown is created.
[in]shape_function_labelString that acts as shape_function_label for which ExtendedUnknown is created.

◆ ExtendedUnknown() [2/3]

MoReFEM::ExtendedUnknown::ExtendedUnknown ( const ExtendedUnknown & rhs)
delete

The copy constructor.

Parameters
[in]rhsThe object from which the construction occurs.

◆ ExtendedUnknown() [3/3]

MoReFEM::ExtendedUnknown::ExtendedUnknown ( ExtendedUnknown && rhs)
delete

The move constructor.

Parameters
[in]rhsThe object from which the construction occurs.

Member Function Documentation

◆ operator=() [1/2]

ExtendedUnknown & MoReFEM::ExtendedUnknown::operator= ( const ExtendedUnknown & rhs)
delete

The (copy) operator=.

Parameters
[in]rhsThe object from which the affectation occurs.
Returns
Reference to the object (to enable chained affectation).

◆ operator=() [2/2]

ExtendedUnknown & MoReFEM::ExtendedUnknown::operator= ( ExtendedUnknown && rhs)
delete

The (move) operator=.

Parameters
[in]rhsThe object from which the affectation occurs.
Returns
Reference to the object (to enable chained affectation).

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