cl_IF_ElementMapper.hpp

Go to the documentation of this file.

/*
 * BELFEM -- The Berkeley Lab Finite Element Framework
 * Copyright (c) 2026, The Regents of the University of California, through
 * Lawrence Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Developers: Christian Messe, Gregory Giard
 *
 * See the top-level LICENSE file for the complete license and disclaimer.
 */
 
#ifndef BELFEM_CL_IF_ELEMENTMAPPER_HPP
#define BELFEM_CL_IF_ELEMENTMAPPER_HPP
 
#include "cl_Element.hpp"
#include "cl_Map.hpp"
#include "cl_IF_InterpolationFunction.hpp"
#include "cl_IF_InterpolationFunctionFactory.hpp"
 
namespace belfem
{
    namespace fem
    {
        class ElementMapper
        {
//------------------------------------------------------------------------------
        private:
//------------------------------------------------------------------------------
 
            ElementType mElementType = ElementType::UNDEFINED ;
 
            InterpolationFunctionFactory * mFactory ;
            Map< ElementType, InterpolationFunction * > mFunctions ;
 
            Matrix< real > mX ;     // node coordinates  ( <num nodes> x <spatial dim> )
            Matrix< real > mJ ;     // jacobian          ( <natural dim> x <natural dim> )
            Matrix< real > mInvJ ;  // jacobian inverse  ( <natural dim> x <natural dim> )
            Matrix< real > mA ;     // bilinear quad coefficients
                                    // rows = {x, y}; cols = {1, xi, eta, xi*eta}
            Matrix< real > mN ;     // shape values      ( 1 x <num nodes> )
            Matrix< real > mNxi ;   // shape derivatives ( <natural dim> x <num nodes> )
 
            Vector< real > mXi0 ;   // centroid seed for Newton
            Vector< real > mRHS ;   // residual / right-hand side
            bool mIsAffin = false ;
 
            uint mDim = 0 ;         // spatial dim of mX; 0 = auto-detect from element
 
            mesh::Element * mElement = nullptr ;
            InterpolationFunction * mFunction = nullptr ;
 
            // dispatch: closed-form solver, initial guess, in-domain predicate
            bool ( ElementMapper::* mFunEval  )( const Vector< real > & aX, Vector< real > & aXi )       = nullptr ;
            bool ( ElementMapper::* mFunGuess )( const Vector< real > & aX, Vector< real > & aXi )       = nullptr ;
            bool ( ElementMapper::* mFunCheck )( const Vector< real > & aXi ) const                       = nullptr ;
 
//------------------------------------------------------------------------------
        public:
//------------------------------------------------------------------------------

            ElementMapper();
 
//------------------------------------------------------------------------------

            ~ElementMapper();
 
//------------------------------------------------------------------------------

            ElementMapper( const ElementMapper & ) = delete ;
            ElementMapper & operator=( const ElementMapper & ) = delete ;
 
//------------------------------------------------------------------------------

            void
            link( mesh::Element * aElement );
 
//------------------------------------------------------------------------------

            bool
            evaluate( const Vector< real > & aX, Vector< real > & aXi );
 
//------------------------------------------------------------------------------

            void
            set_dimension( const uint aDim );
 
//------------------------------------------------------------------------------

            void
            weights( const Vector< real > & aXi, Vector< real > & aWeights );
 
//------------------------------------------------------------------------------
        private:
//------------------------------------------------------------------------------

            bool
            evaluate_tri3( const Vector< real > & aX, Vector< real > & aXi );
 
//------------------------------------------------------------------------------

            bool
            evaluate_quad4( const Vector< real > & aX, Vector< real > & aXi );
 
//------------------------------------------------------------------------------

            bool
            evaluate_tet4( const Vector< real > & aX, Vector< real > & aXi );
 
//------------------------------------------------------------------------------

            bool
            evaluate_general( const Vector< real > & aX, Vector< real > & aXi );
 
//------------------------------------------------------------------------------

            bool
            guess_general( const Vector< real > & aX, Vector< real > & aXi );
 
//------------------------------------------------------------------------------

            bool
            inside_tri( const Vector< real > & aXi ) const ;
 
//------------------------------------------------------------------------------

            bool
            inside_quad( const Vector< real > & aXi ) const ;
 
//------------------------------------------------------------------------------

            bool
            inside_tet( const Vector< real > & aXi ) const ;
 
//------------------------------------------------------------------------------

            bool
            inside_penta( const Vector< real > & aXi ) const ;
 
//------------------------------------------------------------------------------

            bool
            inside_pyra( const Vector< real > & aXi ) const ;
 
//------------------------------------------------------------------------------

            bool
            inside_hex( const Vector< real > & aXi ) const ;
 
//------------------------------------------------------------------------------
        };
//------------------------------------------------------------------------------
    } /* end namespace fem */
} /* end namespace belfem */
#endif //BELFEM_CL_IF_ELEMENTMAPPER_HPP