GRINS::QoIFactory Class Reference

#include <qoi_factory.h>

Public Member Functions
	QoIFactory ()
virtual	~QoIFactory ()
virtual std::tr1::shared_ptr< CompositeQoI >	build (const GetPot &input)

Protected Member Functions
virtual void	add_qoi (const GetPot &input, const std::string &qoi_name, std::tr1::shared_ptr< CompositeQoI > &qois)
virtual void	check_qoi_physics_consistency (const GetPot &input, const std::string &qoi_name)
virtual void	echo_qoi_list (std::tr1::shared_ptr< CompositeQoI > &qois)
void	consistency_helper (const std::set< std::string > &requested_physics, const std::set< std::string > &required_physics, const std::string &qoi_name)
void	consistency_error_msg (const std::string &qoi_name, const std::set< std::string > &required_physics)

Detailed Description

Definition at line 39 of file qoi_factory.h.

Constructor & Destructor Documentation

GRINS::QoIFactory::QoIFactory

(

)

Definition at line 38 of file qoi_factory.C.

  {
    return;
  }

GRINS::QoIFactory::~QoIFactory ( )

virtual

Definition at line 43 of file qoi_factory.C.

  {
    return;
  }

Member Function Documentation

void GRINS::QoIFactory::add_qoi ( const GetPot &  input, const std::string &  qoi_name, std::tr1::shared_ptr< CompositeQoI > &  qois  )

protectedvirtual

Definition at line 80 of file qoi_factory.C.

References GRINS::avg_nusselt, GRINS::parsed_interior, and GRINS::vorticity.

Referenced by build().

  {
    QoIBase* qoi = NULL;

    if( qoi_name == avg_nusselt )
      {
        qoi = new AverageNusseltNumber( avg_nusselt );
      }

    else if( qoi_name == parsed_interior )
      {
        qoi =  new ParsedInteriorQoI( parsed_interior );
      }

    else if( qoi_name == vorticity )
      {
        qoi =  new Vorticity( vorticity );
      }

    else
      {
         libMesh::err << "Error: Invalid QoI name " << qoi_name << std::endl;
         libmesh_error();
      }

    libmesh_assert(qoi);

    qois->add_qoi( *qoi );

    return;
  }

std::tr1::shared_ptr< CompositeQoI > GRINS::QoIFactory::build ( const GetPot &  input )

virtual

Definition at line 48 of file qoi_factory.C.

References add_qoi(), check_qoi_physics_consistency(), echo_qoi_list(), and GRINS::StringUtilities::split_string().

  {
    std::string qoi_list = input("QoI/enabled_qois", "none" );

    std::vector<std::string> qoi_names;

    if( qoi_list != std::string("none") )
      {
        StringUtilities::split_string( qoi_list, std::string(" "), qoi_names );
      }

    std::tr1::shared_ptr<CompositeQoI> qois( new CompositeQoI );
    
    if( !qoi_names.empty() )
      {
        for( std::vector<std::string>::const_iterator name = qoi_names.begin();
             name != qoi_names.end(); ++name )
          {
            this->add_qoi( input, *name, qois );

            this->check_qoi_physics_consistency( input, *name );
          }

        if( input( "screen-options/echo_qoi", false ) )
          {
            this->echo_qoi_list( qois );
          }
      }

    return qois;
  }

void GRINS::QoIFactory::check_qoi_physics_consistency ( const GetPot &  input, const std::string &  qoi_name  )

protectedvirtual

Definition at line 112 of file qoi_factory.C.

References GRINS::avg_nusselt, consistency_helper(), GRINS::heat_transfer, and GRINS::low_mach_navier_stokes.

Referenced by build().

  {
    int num_physics =  input.vector_variable_size("Physics/enabled_physics");

    // This should be checked other places, but let's be double sure.
    libmesh_assert(num_physics > 0);
  
    std::set<std::string> requested_physics;
    std::set<std::string> required_physics;

    // Build Physics name set
    for( int i = 0; i < num_physics; i++ )
      {
        requested_physics.insert( input("Physics/enabled_physics", "NULL", i ) );
      }
  
    /* If it's Nusselt, we'd better have HeatTransfer or LowMachNavierStokes. 
       HeatTransfer implicitly requires fluids, so no need to check for those. `*/
    if( qoi_name == avg_nusselt )
      {
        required_physics.insert(heat_transfer);
        required_physics.insert(low_mach_navier_stokes);
        this->consistency_helper( requested_physics, required_physics, qoi_name );
      }
      
    return;
  }

void GRINS::QoIFactory::consistency_error_msg ( const std::string &  qoi_name, const std::set< std::string > &  required_physics  )

protected

Definition at line 176 of file qoi_factory.C.

Referenced by consistency_helper().

  {
    libMesh::err << "================================================================" << std::endl
                 << "QoI " << qoi_name << std::endl
                 << "requires one of the following physics which were not found:" <<std::endl;
    
    for( std::set<std::string>::const_iterator name = required_physics.begin();
         name != required_physics.end();
         name++ )
      {
        libMesh::err << *name << std::endl;
      }
  
    libMesh::err << "================================================================" << std::endl;

    libmesh_error();
  }

void GRINS::QoIFactory::consistency_helper ( const std::set< std::string > &  requested_physics, const std::set< std::string > &  required_physics, const std::string &  qoi_name  )

protected

Definition at line 157 of file qoi_factory.C.

References consistency_error_msg().

Referenced by check_qoi_physics_consistency().

  {
    bool physics_found = false;
    for( std::set<std::string>::const_iterator name = required_physics.begin();
         name != required_physics.end();
         name++ )
      {
        if( requested_physics.find( (*name) ) != requested_physics.end() )
          physics_found = true;
      }

    if( !physics_found )
      this->consistency_error_msg( qoi_name, required_physics );

    return;
  }

void GRINS::QoIFactory::echo_qoi_list ( std::tr1::shared_ptr< CompositeQoI > &  qois )

protectedvirtual

Todo:

Generalize to multiple QoI case when CompositeQoI is implemented in libMesh

Definition at line 141 of file qoi_factory.C.

Referenced by build().

  {
    std::cout << "==========================================================" << std::endl
              << "List of Enabled QoIs:" << std::endl;
    
    for( unsigned int q = 0; q < qois->n_qois(); q++ )
      {
        std::cout << qois->get_qoi(q).name() << std::endl;      
      }

    std::cout <<  "==========================================================" << std::endl;

    return;
  }

---

The documentation for this class was generated from the following files:

• src/qoi/include/grins/qoi_factory.h
• src/qoi/src/qoi_factory.C