scaling.h

Go to the documentation of this file.

// ------------------------------------------------------------------------------------------------------------------------------
//
// FCST: Fuel Cell Simulation Toolbox
//
// Copyright (C) 2006-2016 by Energy Systems Design Laboratory, University of Alberta
//
// This software is distributed under the MIT license
// For more information, see the README file in /doc/LICENSE
//
// - Class: scaling.h
// - Description: This class allows scaling of any of the vector valued equations by a constant to help with 
//                stability of finding a solution.
//
// - Developers: Chad Balen, University of Alberta
//
// ------------------------------------------------------------------------------------------------------------------------------

#ifndef _FUELCELL_SCALING__H
#define _FUELCELL_SCALING__H

//OpenFCST required header files:
#include <application_core/system_management.h>
#include <utils/fcst_utilities.h> // For converting string to map in initialize()

namespace FuelCell
{
    
    class Scaling
    {
        public:
            Scaling(FuelCell::SystemManagement& system_management);
            
            ~Scaling();
            
            void declare_parameters (ParameterHandler &param) const;

            void initialize (ParameterHandler& param);
            
            const bool get_apply_scaling_bool() const
            {
                return applyScaling;
            }
            
            void scale_cell_matrix(MatrixVector& cell_matrices);
            
            void scale_cell_residual(FEVector& cell_res);
            
            void scale_bdry_matrix(MatrixVector& local_bdry_matrices, MatrixVector& bdry_matrices);
            
            void scale_bdry_residual(FEVector& local_bdry_res, FEVector& bdry_res);
            
            void create_local_bdry_matrix(MatrixVector& local_bdry_matrices, MatrixVector& bdry_matrices);
            
        private:
            FuelCell::SystemManagement* system_management;
            
            bool applyScaling = false;
            
            std::map<std::string, double> ScalingMap;
            
    };
    
}

#endif // _FUELCELL_SCALING__H