cl_JcFunction.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_JCFUNCTION_HPP
#define BELFEM_CL_JCFUNCTION_HPP

 
#include "typedefs.hpp"
#include "cl_Bitset.hpp"
 
namespace belfem
{
    namespace material
    {
//------------------------------------------------------------------------------

        enum class JcParameter
        {
            normB          = 1,
            angleNxB       = 2,
            T              = 3,
            UNDEFINED      = 4
        };

        typedef Bitset< static_cast< uint >( JcParameter::UNDEFINED ) > JcDependency;
 
//------------------------------------------------------------------------------

        class JcFunction
        {
        protected:
 
            JcDependency mDependency ;
 
        public:

            JcFunction() = default;

            virtual
            ~JcFunction() = default;

            bool
            depends_on( const JcParameter aParameter ) const;

            virtual real
            min_value() const
            {
                return BELFEM_QUIET_NAN ;
            }

            bool
            is_constant() const ;

            virtual real
            eval(
                const real normB,
                const real angle
                ) const;

            virtual real
            eval(
                const real normB,
                const real angle,
                const real T
                ) const;

            virtual real
            deval_dB(
                const real normB,
                const real angle,
                const real T
                ) const;

            virtual real
            deval_dbeta(
                const real normB,
                const real angle,
                const real T
                ) const;

            virtual real
            deval_dT(
                const real normB,
                const real angle,
                const real T
                ) const;
 
        protected:

            void
            set_dependency( const JcParameter aParameter );
 
        };
 
        inline bool
        JcFunction::depends_on( const JcParameter aParameter ) const
        {
            return mDependency.test( static_cast< uint >( aParameter ) );
        }
 
        inline bool
        JcFunction::is_constant() const
        {
            return mDependency.count() == 0 ;
        }
 
    }
}
#endif //BELFEM_CL_JCFUNCTION_HPP