GRINS::ParsedSourceTerm Class Reference

#include <parsed_source_term.h>

Inheritance diagram for GRINS::ParsedSourceTerm:

Collaboration diagram for GRINS::ParsedSourceTerm:

Public Member Functions
	ParsedSourceTerm (const std::string &physics_name, const GetPot &input)
virtual	~ParsedSourceTerm ()
virtual void	init_context (AssemblyContext &context)
	Initialize context for added physics variables. More...
virtual void	element_time_derivative (bool compute_jacobian, AssemblyContext &context)
	Time dependent part(s) of physics for element interiors. More...
Public Member Functions inherited from GRINS::SourceTermBase
	SourceTermBase (const std::string &physics_name, const GetPot &input)
virtual	~SourceTermBase ()
virtual void	init_variables (libMesh::FEMSystem *system)
	Initialize variables for this physics. More...
Public Member Functions inherited from GRINS::Physics
	Physics (const GRINS::PhysicsName &physics_name, const GetPot &input)
virtual	~Physics ()
virtual bool	enabled_on_elem (const libMesh::Elem *elem)
	Find if current physics is active on supplied element. More...
void	set_is_steady (bool is_steady)
	Sets whether this physics is to be solved with a steady solver or not. More...
bool	is_steady () const
	Returns whether or not this physics is being solved with a steady solver. More...
virtual void	set_time_evolving_vars (libMesh::FEMSystem *system)
	Set which variables are time evolving. More...
virtual void	auxiliary_init (MultiphysicsSystem &system)
	Any auxillary initialization a Physics class may need. More...
virtual void	register_postprocessing_vars (const GetPot &input, PostProcessedQuantities< libMesh::Real > &postprocessing)
	Register name of postprocessed quantity with PostProcessedQuantities. More...
virtual void	preassembly (MultiphysicsSystem &)
	Perform any necessary setup before element assembly begins. More...
virtual void	reinit (MultiphysicsSystem &)
	Any reinitialization that needs to be done. More...
virtual void	side_time_derivative (bool, AssemblyContext &)
	Time dependent part(s) of physics for boundaries of elements on the domain boundary. More...
virtual void	nonlocal_time_derivative (bool, AssemblyContext &)
	Time dependent part(s) of physics for scalar variables. More...
virtual void	element_constraint (bool, AssemblyContext &)
	Constraint part(s) of physics for element interiors. More...
virtual void	side_constraint (bool, AssemblyContext &)
	Constraint part(s) of physics for boundaries of elements on the domain boundary. More...
virtual void	nonlocal_constraint (bool, AssemblyContext &)
	Constraint part(s) of physics for scalar variables. More...
virtual void	damping_residual (bool, AssemblyContext &)
	Damping matrix part(s) for element interiors. All boundary terms lie within the time_derivative part. More...
virtual void	mass_residual (bool, AssemblyContext &)
	Mass matrix part(s) for element interiors. All boundary terms lie within the time_derivative part. More...
virtual void	nonlocal_mass_residual (bool, AssemblyContext &)
	Mass matrix part(s) for scalar variables. More...
void	init_ics (libMesh::FEMSystem *system, libMesh::CompositeFunction< libMesh::Number > &all_ics)
virtual void	compute_element_time_derivative_cache (AssemblyContext &)
virtual void	compute_side_time_derivative_cache (AssemblyContext &)
virtual void	compute_nonlocal_time_derivative_cache (AssemblyContext &)
virtual void	compute_element_constraint_cache (AssemblyContext &)
virtual void	compute_side_constraint_cache (AssemblyContext &)
virtual void	compute_nonlocal_constraint_cache (AssemblyContext &)
virtual void	compute_damping_residual_cache (AssemblyContext &)
virtual void	compute_mass_residual_cache (AssemblyContext &)
virtual void	compute_nonlocal_mass_residual_cache (AssemblyContext &)
virtual void	compute_postprocessed_quantity (unsigned int quantity_index, const AssemblyContext &context, const libMesh::Point &point, libMesh::Real &value)
ICHandlingBase *	get_ic_handler ()
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...

Protected Attributes
libMesh::ParsedFunction< libMesh::Real >	_value
Protected Attributes inherited from GRINS::SourceTermBase
std::vector< VariableIndex >	_vars
std::vector< std::string >	_var_names
std::vector< GRINSEnums::FEFamily >	_var_FE
std::vector< GRINSEnums::Order >	_var_order
Protected Attributes inherited from GRINS::Physics
const PhysicsName	_physics_name
	Name of the physics object. Used for reading physics specific inputs. More...
GRINS::ICHandlingBase *	_ic_handler
std::set< libMesh::subdomain_id_type >	_enabled_subdomains
	Subdomains on which the current Physics class is enabled. More...

Private Member Functions
	ParsedSourceTerm ()

Additional Inherited Members
Static Public Member Functions inherited from GRINS::Physics
static void	set_is_axisymmetric (bool is_axisymmetric)
	Set whether we should treat the problem as axisymmetric. More...
static bool	is_axisymmetric ()
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...
Protected Member Functions inherited from GRINS::Physics
libMesh::UniquePtr< libMesh::FEGenericBase< libMesh::Real > >	build_new_fe (const libMesh::Elem *elem, const libMesh::FEGenericBase< libMesh::Real > *fe, const libMesh::Point p)
void	parse_enabled_subdomains (const GetPot &input, const std::string &physics_name)
void	check_var_subdomain_consistency (const FEVariablesBase &var) const
	Check that var is enabled on at least the subdomains this Physics is. More...
Static Protected Attributes inherited from GRINS::Physics
static bool	_is_steady = false
	Caches whether or not the solver that's being used is steady or not. More...
static bool	_is_axisymmetric = false
	Caches whether we are solving an axisymmetric problem or not. More...

Detailed Description

Definition at line 37 of file parsed_source_term.h.

Constructor & Destructor Documentation

GRINS::ParsedSourceTerm::ParsedSourceTerm	(	const std::string &	physics_name,
		const GetPot &	input
	)

Definition at line 38 of file parsed_source_term.C.

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

    : SourceTermBase(physics_name,input),
      _value("")
  {
    this->set_parameter(_value, input,
                        "Physics/"+physics_name+"/Function/value",
                        "DIE!");
  }

virtual GRINS::ParsedSourceTerm::~ParsedSourceTerm ( )

inlinevirtual

Definition at line 43 of file parsed_source_term.h.

{}

GRINS::ParsedSourceTerm::ParsedSourceTerm ( )

private

Member Function Documentation

void GRINS::ParsedSourceTerm::element_time_derivative ( bool  , AssemblyContext &    )

virtual

Time dependent part(s) of physics for element interiors.

Reimplemented from GRINS::Physics.

Definition at line 61 of file parsed_source_term.C.

  {
    for( std::vector<VariableIndex>::const_iterator v_it = _vars.begin();
         v_it != _vars.end(); ++v_it )
      {
        VariableIndex var = *v_it;

        // The number of local degrees of freedom in each variable.
        const unsigned int n_dofs = context.get_dof_indices(var).size();

        // Element Jacobian * quadrature weights for interior integration.
        const std::vector<libMesh::Real> &JxW =
          context.get_element_fe(var)->get_JxW();

        // The temperature shape functions at interior quadrature points.
        const std::vector<std::vector<libMesh::Real> >& phi =
          context.get_element_fe(var)->get_phi();

        const std::vector<libMesh::Point>& x_qp = context.get_element_fe(var)->get_xyz();

        // Get residuals
        libMesh::DenseSubVector<libMesh::Number> &F_var = context.get_elem_residual(var);

        libMesh::Real t = context.get_time();

        // Now we will build the element Jacobian and residual.
        // Constructing the residual requires the solution and its
        // gradient from the previous timestep.  This must be
        // calculated at each quadrature point by summing the
        // solution degree-of-freedom values by the appropriate
        // weight functions.
        unsigned int n_qpoints = context.get_element_qrule().n_points();

        for (unsigned int qp=0; qp != n_qpoints; qp++)
          {
            libMesh::Real value = (this->_value)(x_qp[qp],t);

            for (unsigned int i=0; i != n_dofs; i++)
              {
                F_var(i) += value*phi[i][qp]*JxW[qp];
              }
          }

      } // Variable loop

    return;
  }

void GRINS::ParsedSourceTerm::init_context ( AssemblyContext &  context )

virtual

Initialize context for added physics variables.

Reimplemented from GRINS::Physics.

Definition at line 47 of file parsed_source_term.C.

References GRINS::SourceTermBase::_vars.

  {
    for( std::vector<VariableIndex>::const_iterator v_it = _vars.begin();
         v_it != _vars.end(); ++v_it )
      {
        VariableIndex var = *v_it;

        context.get_element_fe(var)->get_JxW();
        context.get_element_fe(var)->get_phi();
        context.get_element_fe(var)->get_xyz();
      }
  }

Member Data Documentation

libMesh::ParsedFunction<libMesh::Real> GRINS::ParsedSourceTerm::_value

protected

Definition at line 52 of file parsed_source_term.h.

Referenced by ParsedSourceTerm().

---

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

• src/physics/include/grins/parsed_source_term.h
• src/physics/src/parsed_source_term.C