composite_qoi.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2015 Paul T. Bauman, Roy H. Stogner
// Copyright (C) 2010-2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef GRINS_COMPOSITE_QOI_H
#define GRINS_COMPOSITE_QOI_H

// C++
#include <vector>
#include <ostream>

// libMesh
#include "libmesh/libmesh_common.h"
#include "libmesh/diff_qoi.h"

// libMesh forward declarations
class GetPot;
namespace libMesh
{
  class DiffContext;
  class QoISet;
  namespace Parallel
  {
    class Communicator;
  }
}

// GRINS
#include "grins/qoi_base.h"

namespace GRINS
{
  // GRINS forward declarations
  class MultiphysicsSystem;

  class CompositeQoI : public libMesh::DifferentiableQoI
  {
  public:
    CompositeQoI();

    virtual ~CompositeQoI();


    virtual libMesh::AutoPtr<libMesh::DifferentiableQoI> clone();

    virtual void add_qoi( const QoIBase& qoi );

    unsigned int n_qois() const;

    //  named in this call.
    void register_parameter
      ( const std::string & param_name,
        libMesh::ParameterMultiPointer<libMesh::Number>& param_pointer)
    const;

    virtual void init( const GetPot& input, const MultiphysicsSystem& system );

    virtual void init_qoi( std::vector<libMesh::Number>& sys_qoi );

    virtual void init_context( libMesh::DiffContext& context );

    virtual void element_qoi( libMesh::DiffContext& context,
                              const libMesh::QoISet& qoi_indices );

    virtual void element_qoi_derivative( libMesh::DiffContext &context,
                                         const libMesh::QoISet &qoi_indices );

    virtual void side_qoi( libMesh::DiffContext& context, const libMesh::QoISet& qoi_indices );

    virtual void side_qoi_derivative( libMesh::DiffContext &context, const libMesh::QoISet &qois );


    virtual void parallel_op( const libMesh::Parallel::Communicator& communicator,
                              std::vector<libMesh::Number>& sys_qoi,
                              std::vector<libMesh::Number>& local_qoi,
                              const libMesh::QoISet& qoi_indices );


    virtual void thread_join( std::vector<libMesh::Number>& qoi,
                              const std::vector<libMesh::Number>& other_qoi,
                              const libMesh::QoISet& qoi_indices );

    void output_qoi( std::ostream& out ) const;

    libMesh::Number get_qoi_value( unsigned int qoi_index ) const;

    const QoIBase& get_qoi( unsigned int qoi_index ) const;

  protected:
    
    std::vector<QoIBase*> _qois;

  };

  inline
  unsigned int CompositeQoI::n_qois() const
  {
    return _qois.size();
  }

  inline
  const QoIBase& CompositeQoI::get_qoi( unsigned int qoi_index ) const
  {
    libmesh_assert_less( qoi_index, this->n_qois() );

    return (*_qois[qoi_index]);
  }

} // end namespace GRINS

#endif // GRINS_COMPOSITE_QOI_H