cl_MaterialFactory.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 CL_MATERIALFACTORY_HPP
#define CL_MATERIALFACTORY_HPP
 
#include "cl_Material.hpp"
#include "cl_BhCurve.hpp"
#include "cl_JcFunction.hpp"
#include "cl_Input_Section.hpp"
 
namespace belfem
{
//------------------------------------------------------------------------------

    class MaterialFactory
    {
 
        Map < string ,Material * > mMaterialsMap ; //the material map, with labels as keys
 
        // the body of the input-section constructor; the constructor frees
        // the map if it throws
        void
        create_materials( const input::Section * aSection, const bool aBuildTables );
//------------------------------------------------------------------------------
    public:
//------------------------------------------------------------------------------
 
        MaterialFactory() = default;

        MaterialFactory( const input::Section * aSection,
                         const bool aBuildTables = true );
 
        ~MaterialFactory() = default;
 
//------------------------------------------------------------------------------

        Material *
        create_material( const string & aLabel,
                         const real aRRR = BELFEM_QUIET_NAN,
                         const bool aBuildTables = true );
 
//------------------------------------------------------------------------------
 
        enum class BuiltinKind
        {
            Iron,       
            OtherKnown, 
            Unknown     
        };

        static BuiltinKind
        builtin_kind( const string & aName );

        static bool
        curve_tolerates_builtin( const string & aValue );

        static bool
        is_pure_metal_label( const string & aLabel );
 
//------------------------------------------------------------------------------
 
        void
        print_material_list( std::ostream & aStream );
 
//------------------------------------------------------------------------------

        Material *
        create_material( const string & aLibraryPath, const string & aLabel );
 
//------------------------------------------------------------------------------
 
        Map <string, Material *> &
        materials();
 
//------------------------------------------------------------------------------

        material::BhCurve *
        create_bh_curve( const string & aPath, const string & aLabel );
 
//------------------------------------------------------------------------------

        material::JcFunction *
        create_jc_function( const real aJc0, const real aB, const real aBc, const real aK );
 
//------------------------------------------------------------------------------

        material::JcFunction *
        create_jc_function( const string & aPath, const string & aLabel );
 
//------------------------------------------------------------------------------

        void
        check_unused_input(
                const input::Section * aSection,
                const string         & aLabel,
                const string         & aShape,
                const Cell< string > & aKeys,
                const Cell< string > & aSections );
 
//------------------------------------------------------------------------------
    };
 
    inline Map <string, Material *> &
    MaterialFactory::materials()
    {
        return mMaterialsMap ;
    }
 
//------------------------------------------------------------------------------
}
#endif //CL_MATERIALFACTORY_HPP