application_wrapper.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
//
// FCST: Fuel Cell Simulation Toolbox
//
// Copyright (C) 2006-2009 by Guido Kanschat
// Copyright (C) 2006-2014 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: application_wrapper.h
// - Description: This class implements either iterative or time-stepping
//                wrapper of applications
// - Developers: Guido Kanschat,     Texas A&M University
//               Valentin N. Zingan, University of Alberta
//               Marc Secanell,      University of Alberta
//
// ----------------------------------------------------------------------------

#ifndef _FUEL_CELL_APPLICATION_CORE_APPLICATION_WRAPPER_H_
#define _FUEL_CELL_APPLICATION_CORE_APPLICATION_WRAPPER_H_

#include <application_core/application_base.h>

using namespace dealii;

namespace FuelCell
{
    namespace ApplicationCore
    {
        
        class ApplicationWrapper : public ApplicationBase
        {
        public:
            
            ApplicationWrapper(ApplicationBase& app);
            
            ~ApplicationWrapper();
            
            virtual void declare_parameters(ParameterHandler& param);
            
            virtual void initialize(ParameterHandler& param);
            
            virtual void remesh();
            
            virtual void init_vector(FEVector& dst) const;
            
            virtual double residual(FEVector&        dst,
                                    const FEVectors& src,
                                    bool             apply_boundaries = true);
            
            virtual void solve(FEVector&        dst,
                               const FEVectors& src);
            
            virtual void Tsolve(FEVector&        dst,
                                const FEVectors& src);
            
            virtual double estimate(const FEVectors& src);
            
            virtual double evaluate(const FEVectors& src);
            
            virtual void grid_out(const std::string& filename) const;
            
            virtual void data_out(const std::string& filename,
                                  const FEVectors&   src);
            
            virtual std::string id() const;
            
            virtual void notify(const Event& reason);
            
        protected:
            SmartPointer<ApplicationBase> get_wrapped_application()
            {
                return app;
            }
            
            SmartPointer<ApplicationBase> app;
        };
        
    } // ApplicationCore
    
} // FuelCell

#endif