#include <variable_pinning.h>

Inheritance diagram for GRINS::VariablePinning:

Collaboration diagram for GRINS::VariablePinning:

Public Member Functions
	VariablePinning (const GRINS::PhysicsName &physics_name, const GetPot &input)

	~VariablePinning ()

virtual void	init_context (AssemblyContext &context)
	Initialize context for added physics variables. More...

virtual void	auxiliary_init (MultiphysicsSystem &system)
	Initialize pinning helper object. More...

virtual void	element_constraint (bool compute_jacobian, AssemblyContext &context)
	Time dependent part(s) of physics for element interiors. More...

Public Member Functions inherited from GRINS::Physics
	Physics (const GRINS::PhysicsName &physics_name, const GetPot &input)

virtual	~Physics ()

virtual void	init_variables (libMesh::FEMSystem *)
	Initialize variables for this physics. More...

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	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	element_time_derivative (bool, AssemblyContext &)
	Time dependent part(s) of physics for element interiors. 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	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
PressurePinning	_var_pinning

std::string	_variablename_to_pin

unsigned int	_variable_to_pin

libMesh::Real	_penalty

bool	_pin_variable

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
	VariablePinning ()

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 35 of file variable_pinning.h.

Constructor & Destructor Documentation

GRINS::VariablePinning::VariablePinning	(	const GRINS::PhysicsName &	physics_name,
		const GetPot &	input
	)

Definition at line 39 of file variable_pinning.C.

References _pin_variable, _variablename_to_pin, and GRINS::PhysicsNaming::variable_pinning().

     : Physics(physics_name,input),
       _var_pinning(input,physics_name),
       _penalty(input("Physics/" + PhysicsNaming::variable_pinning() + "/penalty", 1e10)),
       _pin_variable(false)
   {
     std::string pin_variable_str = "Physics/" +
       PhysicsNaming::variable_pinning() + "/pin_variable";
     if (input.have_variable(pin_variable_str))
       {
         _variablename_to_pin = input(pin_variable_str, std::string());
         _pin_variable = true;
       }
   }

GRINS::VariablePinning::~VariablePinning ( )

inline

Definition at line 41 of file variable_pinning.h.

41 {};

GRINS::VariablePinning::VariablePinning ( )

private

Member Function Documentation

void GRINS::VariablePinning::auxiliary_init ( MultiphysicsSystem & system )

virtual

Initialize pinning helper object.

Reimplemented from GRINS::Physics.

Definition at line 54 of file variable_pinning.C.

References _pin_variable, _var_pinning, _variable_to_pin, _variablename_to_pin, and GRINS::PressurePinning::check_pin_location().

   {
     if( _pin_variable )
       {
         _variable_to_pin =
           system.variable_number(_variablename_to_pin);
         _var_pinning.check_pin_location(system.get_mesh());
       }
     else
       {
         // Commenting out pin_variable makes testing easier but never
         // makes sense in a real run.
         libMesh::out <<
           "Warning!  VariablePinning physics requested but not used!"
                      << std::endl;
       }
   }

void GRINS::VariablePinning::element_constraint	(	bool	compute_jacobian,
		AssemblyContext &	context
	)

virtual

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

Reimplemented from GRINS::Physics.

Definition at line 85 of file variable_pinning.C.

   {
     // Pin var = var_value at p_point
     if( _pin_variable )
       _var_pinning.pin_value( context, compute_jacobian, this->_variable_to_pin, this->_penalty );
   }

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

virtual

Initialize context for added physics variables.

Reimplemented from GRINS::Physics.

Definition at line 72 of file variable_pinning.C.

References _pin_variable, and _variable_to_pin.

   {
     // We should prerequest all the data
     // we will need to build the linear system
     // or evaluate a quantity of interest.
     if ( _pin_variable )
       {
         context.get_element_fe(_variable_to_pin)->get_JxW();
         context.get_element_fe(_variable_to_pin)->get_phi();
       }
   }

Member Data Documentation

libMesh::Real GRINS::VariablePinning::_penalty

protected

Definition at line 64 of file variable_pinning.h.

bool GRINS::VariablePinning::_pin_variable

protected

Definition at line 66 of file variable_pinning.h.

Referenced by auxiliary_init(), init_context(), and VariablePinning().

PressurePinning GRINS::VariablePinning::_var_pinning

protected

Definition at line 58 of file variable_pinning.h.

Referenced by auxiliary_init().

unsigned int GRINS::VariablePinning::_variable_to_pin

protected

Definition at line 62 of file variable_pinning.h.

Referenced by auxiliary_init(), and init_context().

std::string GRINS::VariablePinning::_variablename_to_pin

protected

Definition at line 60 of file variable_pinning.h.

Referenced by auxiliary_init(), and VariablePinning().

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

src/physics/include/grins/variable_pinning.h
src/physics/src/variable_pinning.C

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation