GRINS::ParameterUser Class Reference

ParameterUser base class. Utility methods for subclasses. More...

#include <parameter_user.h>

Inheritance diagram for GRINS::ParameterUser:

Public Member Functions
	ParameterUser (const std::string &user_name)
virtual	~ParameterUser ()
virtual void	set_parameter (libMesh::Number &param_variable, const GetPot &input, const std::string &param_name, libMesh::Number param_default)
	Each subclass can simultaneously read a parameter value from. More...
virtual void	register_parameter (const std::string &param_name, libMesh::ParameterMultiPointer< libMesh::Number > &param_pointer) const
	Each subclass will register its copy of an independent. More...

Private Attributes
std::map< std::string, libMesh::Number * >	_my_parameters
std::string	_my_name

Detailed Description

ParameterUser base class. Utility methods for subclasses.

This base class defines utility methods with which a subclass can simultaneously set a parameter from an input file and register that parameter (by input file variable name) for later parameter sensitivity studies.

Definition at line 61 of file parameter_user.h.

Constructor & Destructor Documentation

GRINS::ParameterUser::ParameterUser ( const std::string &  user_name )

inline

Definition at line 66 of file parameter_user.h.

: _my_name(user_name) {}

virtual GRINS::ParameterUser::~ParameterUser ( )

inlinevirtual

Definition at line 67 of file parameter_user.h.

{}

Member Function Documentation

void GRINS::ParameterUser::register_parameter ( const std::string &  param_name, libMesh::ParameterMultiPointer< libMesh::Number > &  param_pointer  ) const

virtual

Each subclass will register its copy of an independent.

Reimplemented in GRINS::AxisymmetricHeatTransfer< Conductivity >, GRINS::LowMachNavierStokesBase< Viscosity, SpecificHeat, ThermalConductivity >, GRINS::IncompressibleNavierStokesBase< Viscosity >, GRINS::BoussinesqBuoyancySPGSMStabilization< Viscosity >, GRINS::HeatConduction< Conductivity >, GRINS::HeatTransferBase< Conductivity >, and GRINS::BoussinesqBuoyancyAdjointStabilization< Viscosity >.

Definition at line 50 of file parameter_user.C.

Referenced by GRINS::BoussinesqBuoyancyAdjointStabilization< Viscosity >::register_parameter(), GRINS::HeatTransferBase< Conductivity >::register_parameter(), GRINS::HeatConduction< Conductivity >::register_parameter(), GRINS::BoussinesqBuoyancySPGSMStabilization< Viscosity >::register_parameter(), GRINS::IncompressibleNavierStokesBase< Viscosity >::register_parameter(), GRINS::LowMachNavierStokesBase< Viscosity, SpecificHeat, ThermalConductivity >::register_parameter(), and GRINS::AxisymmetricHeatTransfer< Conductivity >::register_parameter().

  {
    std::map<std::string, libMesh::Number*>::const_iterator it =
      _my_parameters.find(param_name);

    if (it != _my_parameters.end())
      {
        std::cout << _my_name << " uses parameter " << param_name
                  << std::endl;
        param_pointer.push_back(it->second);
      }
  }

void GRINS::ParameterUser::set_parameter ( libMesh::Number &  param_variable, const GetPot &  input, const std::string &  param_name, libMesh::Number  param_default  )

virtual

Each subclass can simultaneously read a parameter value from.

Definition at line 35 of file parameter_user.C.

References _my_name, and _my_parameters.

Referenced by GRINS::AveragedFanAdjointStabilization< Viscosity >::AveragedFanAdjointStabilization(), GRINS::AveragedTurbineAdjointStabilization< Viscosity >::AveragedTurbineAdjointStabilization(), GRINS::BoussinesqBuoyancyAdjointStabilization< Viscosity >::BoussinesqBuoyancyAdjointStabilization(), GRINS::BoussinesqBuoyancyBase::BoussinesqBuoyancyBase(), GRINS::BoussinesqBuoyancySPGSMStabilization< Viscosity >::BoussinesqBuoyancySPGSMStabilization(), GRINS::ConstantConductivity::ConstantConductivity(), GRINS::ConstantPrandtlConductivity::ConstantPrandtlConductivity(), GRINS::ConstantSourceFunction::ConstantSourceFunction(), GRINS::ConstantSourceTerm::ConstantSourceTerm(), GRINS::ConstantSpecificHeat::ConstantSpecificHeat(), GRINS::ConstantViscosity::ConstantViscosity(), GRINS::ElasticCable< StressStrainLaw >::ElasticCable(), GRINS::ElasticCableConstantGravity::ElasticCableConstantGravity(), GRINS::ElasticMembrane< StressStrainLaw >::ElasticMembrane(), GRINS::ElasticMembraneConstantPressure::ElasticMembraneConstantPressure(), GRINS::HeatConduction< Conductivity >::HeatConduction(), GRINS::HeatTransferBase< Conductivity >::HeatTransferBase(), GRINS::IncompressibleNavierStokesBase< Viscosity >::IncompressibleNavierStokesBase(), GRINS::AverageNusseltNumber::init(), GRINS::MooneyRivlin::MooneyRivlin(), GRINS::ReactingLowMachNavierStokesBase< Mixture, Evaluator >::ReactingLowMachNavierStokesBase(), GRINS::HookesLaw1D::read_input_options(), GRINS::HookesLaw::read_input_options(), GRINS::AxisymmetricBoussinesqBuoyancy::read_input_options(), and GRINS::VelocityDragAdjointStabilization< Viscosity >::VelocityDragAdjointStabilization().

  {
    param_variable = input(param_name, param_default);

    libmesh_assert_msg(!_my_parameters.count(param_name),
      "ERROR: " << _my_name << " double-registered parameter " <<
      param_name);

    _my_parameters[param_name] = &param_variable;
  }

Member Data Documentation

std::string GRINS::ParameterUser::_my_name

private

Definition at line 95 of file parameter_user.h.

Referenced by set_parameter().

std::map<std::string, libMesh::Number*> GRINS::ParameterUser::_my_parameters

private

Definition at line 91 of file parameter_user.h.

Referenced by set_parameter().

---

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

• src/solver/include/grins/parameter_user.h
• src/solver/src/parameter_user.C