GRINS::ConstantSpecificHeat Class Reference

#include <constant_specific_heat.h>

Inheritance diagram for GRINS::ConstantSpecificHeat:

Collaboration diagram for GRINS::ConstantSpecificHeat:

Public Member Functions
	ConstantSpecificHeat (const GetPot &input, const std::string &material)
	Constructor with specified material. More...
	ConstantSpecificHeat (const GetPot &input)
	Deprecated constructor. More...
virtual	~ConstantSpecificHeat ()
libMesh::Real	operator() () const
libMesh::Real	operator() (const libMesh::Real T) const
libMesh::Real	deriv (const libMesh::Real T) const
Public Member Functions inherited from GRINS::ParameterUser
	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	set_parameter (libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...
virtual void	set_parameter (libMesh::ParsedFEMFunction< libMesh::Number > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...
virtual void	move_parameter (const libMesh::Number &old_parameter, libMesh::Number &new_parameter)
	When cloning an object, we need to update parameter pointers. More...
virtual void	move_parameter (const libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &old_func, libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &new_func)
	When cloning an object, we need to update parameter pointers. More...
virtual void	move_parameter (const libMesh::ParsedFEMFunction< libMesh::Number > &old_func, libMesh::ParsedFEMFunction< libMesh::Number > &new_func)
	When cloning an object, we need to update parameter pointers. More...
virtual void	register_parameter (const std::string &param_name, libMesh::ParameterMultiAccessor< libMesh::Number > &param_pointer) const
	Each subclass will register its copy of an independent. More...

Private Member Functions
	ConstantSpecificHeat ()

Private Attributes
libMesh::Real	_cp

Additional Inherited Members
Static Public Attributes inherited from GRINS::ParameterUser
static std::string	zero_vector_function = std::string("{0}")
	A parseable function string with LIBMESH_DIM components, all 0. More...

Detailed Description

Definition at line 39 of file constant_specific_heat.h.

Constructor & Destructor Documentation

GRINS::ConstantSpecificHeat::ConstantSpecificHeat	(	const GetPot &	input,
		const std::string &	material
	)

Constructor with specified material.

Will look in the input file for [Materials/material/SpecificHeat/value] for the value of specific heat.

Definition at line 60 of file constant_specific_heat.C.

References _cp, GRINS::MaterialsParsing::dep_input_warning(), GRINS::MaterialsParsing::duplicate_input_test(), and GRINS::ParameterUser::set_parameter().

    : ParameterUser("ConstantSpecificHeat"),
      _cp(0.0)
  {
    // It's an error to have both the old and new version
    MaterialsParsing::duplicate_input_test(input,
                                           "Materials/"+material+"/SpecificHeat/value",
                                           "Materials/SpecificHeat/cp");

    // If we have the "new" version, then parse it
    if( input.have_variable("Materials/"+material+"/SpecificHeat/value") )
      {
        this->set_parameter
          (_cp, input, "Materials/"+material+"/SpecificHeat/value", _cp);
      }
    // If instead we have the old version, use that.
    else if( input.have_variable("Materials/SpecificHeat/cp") )
      {
        MaterialsParsing::dep_input_warning( "Materials/SpecificHeat/cp",
                                             "SpecificHeat/value" );

        this->set_parameter
          (_cp, input, "Materials/SpecificHeat/cp", _cp);
      }
    else
      {
        libmesh_error_msg("ERROR: Could not find valid input for ConstantSpecificHeat! Please set Materials/"+material+"/SpecificHeat/value");
      }
  }

GRINS::ConstantSpecificHeat::ConstantSpecificHeat

(

const GetPot &

input

)

Deprecated constructor.

Definition at line 39 of file constant_specific_heat.C.

References _cp, grins_warning, and GRINS::ParameterUser::set_parameter().

    : ParameterUser("ConstantSpecificHeat"),
      _cp(0.0)
  {
    // Warning about this constructor being deprecated
    {
      std::string warning = "WARNING: Use of this constructor is DEPRECATED.\n";
      warning += "         Please update to use constructor with input material name.\n";
      grins_warning(warning);
    }

    if( !input.have_variable("Materials/SpecificHeat/cp") )
      {
        std::cerr << "Error: Must specify cp value for constant specific heat model!" << std::endl;
        libmesh_error();
      }

    this->set_parameter
      (_cp, input, "Materials/SpecificHeat/cp", _cp);
  }

GRINS::ConstantSpecificHeat::~ConstantSpecificHeat ( )

virtual

Definition at line 91 of file constant_specific_heat.C.

  {
    return;
  }

GRINS::ConstantSpecificHeat::ConstantSpecificHeat ( )

private

Member Function Documentation

libMesh::Real GRINS::ConstantSpecificHeat::deriv ( const libMesh::Real  T ) const

inline

Definition at line 80 of file constant_specific_heat.h.

  {
    return 0.0;
  }

libMesh::Real GRINS::ConstantSpecificHeat::operator() ( ) const

inline

Definition at line 68 of file constant_specific_heat.h.

References _cp.

  {
    return _cp;
  }

libMesh::Real GRINS::ConstantSpecificHeat::operator() ( const libMesh::Real  T ) const

inline

Definition at line 74 of file constant_specific_heat.h.

  {
    return (*this)();
  }

Member Data Documentation

libMesh::Real GRINS::ConstantSpecificHeat::_cp

private

Definition at line 62 of file constant_specific_heat.h.

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

---

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

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