GRINS::ConstantSourceFunction Class Reference

#include <constant_source_func.h>

Inheritance diagram for GRINS::ConstantSourceFunction:

Collaboration diagram for GRINS::ConstantSourceFunction:

Public Member Functions
	ConstantSourceFunction (const GetPot &input)
	~ConstantSourceFunction ()
libMesh::Real	operator() (const libMesh::Point &) const
libMesh::Gradient	grad (const libMesh::Point &) const
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...

Protected Attributes
libMesh::Real	_value

Detailed Description

Definition at line 39 of file constant_source_func.h.

Constructor & Destructor Documentation

GRINS::ConstantSourceFunction::ConstantSourceFunction

(

const GetPot &

input

)

Definition at line 31 of file constant_source_func.C.

References _value, and GRINS::ParameterUser::set_parameter().

    : ParameterUser("ConstantSourceFunction"),
      _value(0.0)
  {
    this->set_parameter
      (_value, input, "Physics/SourceFunction/value", _value);
  }

GRINS::ConstantSourceFunction::~ConstantSourceFunction

(

)

Definition at line 39 of file constant_source_func.C.

  {
    return;
  }

Member Function Documentation

libMesh::Gradient GRINS::ConstantSourceFunction::grad ( const libMesh::Point &  ) const

inline

Definition at line 52 of file constant_source_func.h.

    {
      return libMesh::Gradient();
    }

libMesh::Real GRINS::ConstantSourceFunction::operator() ( const libMesh::Point &  ) const

inline

Definition at line 47 of file constant_source_func.h.

References _value.

    {
      return _value;
    }

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

virtualinherited

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  )

virtualinherited

Each subclass can simultaneously read a parameter value from.

Definition at line 35 of file parameter_user.C.

References GRINS::ParameterUser::_my_name, and GRINS::ParameterUser::_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(), 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

libMesh::Real GRINS::ConstantSourceFunction::_value

protected

Definition at line 59 of file constant_source_func.h.

Referenced by ConstantSourceFunction(), and operator()().

---

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

• src/properties/include/grins/constant_source_func.h
• src/properties/src/constant_source_func.C