#include <boussinesq_buoyancy_base.h>

Inheritance diagram for GRINS::BoussinesqBuoyancyBase:

Collaboration diagram for GRINS::BoussinesqBuoyancyBase:

Public Member Functions
	BoussinesqBuoyancyBase (const std::string &physics_name, const GetPot &input)

	~BoussinesqBuoyancyBase ()

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	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	init_context (AssemblyContext &context)
	Initialize context for added physics variables. 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	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 Member Functions
void	read_property (const GetPot &input, const std::string &old_option, const std::string &property, libMesh::Real &value)
	Helper function for parsing/maintaing backward compatibility. More...

void	no_input_warning (const GetPot &input, const std::string &old_option, const std::string &material, const std::string &property)
	Helper function for parsing/maintaing backward compatibility. 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...

Protected Attributes
const VelocityVariable &	_flow_vars

const PressureFEVariable &	_press_var

const PrimitiveTempFEVariables &	_temp_vars

libMesh::Number	_rho
	$\rho =$ density More...

libMesh::Number	_T_ref
	reference temperature More...

libMesh::Number	_beta_T
	$\beta_T =$ coefficient of thermal expansion More...

libMesh::Point	_g
	Gravitational vector. More...

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

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...

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 39 of file boussinesq_buoyancy_base.h.

Constructor & Destructor Documentation

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

Definition at line 44 of file boussinesq_buoyancy_base.C.

References _beta_T, _flow_vars, _g, _press_var, _rho, _T_ref, _temp_vars, GRINS::PhysicsNaming::boussinesq_buoyancy(), GRINS::Physics::check_var_subdomain_consistency(), and read_property().

     : Physics(physics_name,input),
       _flow_vars(GRINSPrivate::VariableWarehouse::get_variable_subclass<VelocityVariable>(VariablesParsing::velocity_variable_name(input,physics_name,VariablesParsing::PHYSICS))),
       _press_var(GRINSPrivate::VariableWarehouse::get_variable_subclass<PressureFEVariable>(VariablesParsing::press_variable_name(input,physics_name,VariablesParsing::PHYSICS))),
       _temp_vars(GRINSPrivate::VariableWarehouse::get_variable_subclass<PrimitiveTempFEVariables>(VariablesParsing::temp_variable_name(input,physics_name,VariablesParsing::PHYSICS))),
       _rho(0.0),
       _T_ref(1.0),
       _beta_T(1.0)
   {
     this->read_property(input,
                         "Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/rho_ref",
                         "Density",
                         _rho);
 
     this->read_property(input,
                         "Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/T_ref",
                         "ReferenceTemperature",
                         _T_ref);
 
 
     this->read_property(input,
                         "Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/beta_T",
                         "ThermalExpansionCoeff",
                         _beta_T);
 
     unsigned int g_dim = input.vector_variable_size("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g");
 
     _g(0) = input("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g", 0.0, 0 );
     _g(1) = input("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g", 0.0, 1 );
 
     if( g_dim == 3)
       _g(2) = input("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g", 0.0, 2 );
 
     this->check_var_subdomain_consistency(_flow_vars);
     this->check_var_subdomain_consistency(_press_var);
     this->check_var_subdomain_consistency(_temp_vars);
   }

GRINS::BoussinesqBuoyancyBase::~BoussinesqBuoyancyBase ( )

inline

Definition at line 45 of file boussinesq_buoyancy_base.h.

45 {};

GRINS::BoussinesqBuoyancyBase::BoussinesqBuoyancyBase ( )

private

Member Function Documentation

void GRINS::BoussinesqBuoyancyBase::no_input_warning	(	const GetPot &	input,
		const std::string &	old_option,
		const std::string &	material,
		const std::string &	property
	)

protected

Helper function for parsing/maintaing backward compatibility.

Definition at line 128 of file boussinesq_buoyancy_base.C.

References GRINS::PhysicsNaming::boussinesq_buoyancy(), grins_warning, and GRINS::MaterialsParsing::have_material().

Referenced by read_property().

   {
     std::string warning;
     if( !MaterialsParsing::have_material(input,PhysicsNaming::boussinesq_buoyancy()) )
       {
         warning = "WARNING: Neither "+old_option+"\n";
         warning += "         nor a material_name was detected in input\n";
         warning +  "         "+property+" is defaulting to 1.0. This behavior is DEPRECATED!\n";
         warning += "         Please update to use Material/MATERIAL_NAME/"+property+"/value\n";
       }
     else
       {
         warning = "WARNING: Neither "+old_option+"\n";
         warning += "         nor Material/"+material+"/"+property+"/value\n";
         warning +  "         "+property+" is defaulting to 1.0. This behavior is DEPRECATED!\n";
         warning += "         Please update to use Material/MATERIAL_NAME/"+property+"/value\n";
       }
 
     grins_warning(warning);
   }

void GRINS::BoussinesqBuoyancyBase::read_property	(	const GetPot &	input,
		const std::string &	old_option,
		const std::string &	property,
		libMesh::Real &	value
	)

protected

Helper function for parsing/maintaing backward compatibility.

Definition at line 82 of file boussinesq_buoyancy_base.C.

References GRINS::PhysicsNaming::boussinesq_buoyancy(), GRINS::MaterialsParsing::dep_input_warning(), GRINS::MaterialsParsing::duplicate_input_test(), GRINS::MaterialsParsing::material_name(), no_input_warning(), and GRINS::ParameterUser::set_parameter().

Referenced by BoussinesqBuoyancyBase().

   {
     std::string material = MaterialsParsing::material_name(input,PhysicsNaming::boussinesq_buoyancy());
 
     // Can't specify both material and rho_ref
     MaterialsParsing::duplicate_input_test(input,
                                            old_option,
                                            "Materials/"+material+"/"+property+"/value" );
 
     // Deprecated
     if( input.have_variable(old_option) )
       {
         MaterialsParsing::dep_input_warning( old_option,property+"/value" );
 
         this->set_parameter
           (value, input,
            old_option, 1.0 /*Old default*/);
       }
     // Preferred
     else if( input.have_variable("Materials/"+material+"/"+property+"/value" ) )
       {
         this->set_parameter
           (value, input,
            "Materials/"+material+"/"+property+"/value", 0.0 /*default*/);
       }
     // If nothing was set, we default to 1.0. Deprecated, what was I thinking
     else
       {
         this->no_input_warning( input,
                                 old_option,
                                 material,
                                 property );
         this->set_parameter
           (value, input, old_option, 1.0 /*default*/);
       }
 
     // Make sure density is positive
     if( value <= 0.0 )
       {
         libmesh_error_msg("ERROR: Detected non-positive "+property+"!");
       }
   }