GRINS-0.8.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
GRINS::BoussinesqBuoyancyBase Class Reference

#include <boussinesq_buoyancy_base.h>

Inheritance diagram for GRINS::BoussinesqBuoyancyBase:
Inheritance graph
[legend]
Collaboration diagram for GRINS::BoussinesqBuoyancyBase:
Collaboration graph
[legend]

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)
 
ICHandlingBaseget_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
 $ T_0 = $ 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().

45  : Physics(physics_name,input),
46  _flow_vars(GRINSPrivate::VariableWarehouse::get_variable_subclass<VelocityVariable>(VariablesParsing::velocity_variable_name(input,physics_name,VariablesParsing::PHYSICS))),
47  _press_var(GRINSPrivate::VariableWarehouse::get_variable_subclass<PressureFEVariable>(VariablesParsing::press_variable_name(input,physics_name,VariablesParsing::PHYSICS))),
48  _temp_vars(GRINSPrivate::VariableWarehouse::get_variable_subclass<PrimitiveTempFEVariables>(VariablesParsing::temp_variable_name(input,physics_name,VariablesParsing::PHYSICS))),
49  _rho(0.0),
50  _T_ref(1.0),
51  _beta_T(1.0)
52  {
53  this->read_property(input,
54  "Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/rho_ref",
55  "Density",
56  _rho);
57 
58  this->read_property(input,
59  "Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/T_ref",
60  "ReferenceTemperature",
61  _T_ref);
62 
63 
64  this->read_property(input,
65  "Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/beta_T",
66  "ThermalExpansionCoeff",
67  _beta_T);
68 
69  unsigned int g_dim = input.vector_variable_size("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g");
70 
71  _g(0) = input("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g", 0.0, 0 );
72  _g(1) = input("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g", 0.0, 1 );
73 
74  if( g_dim == 3)
75  _g(2) = input("Physics/"+PhysicsNaming::boussinesq_buoyancy()+"/g", 0.0, 2 );
76 
80  }
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.
libMesh::Point _g
Gravitational vector.
const PressureFEVariable & _press_var
const VelocityVariable & _flow_vars
void check_var_subdomain_consistency(const FEVariablesBase &var) const
Check that var is enabled on at least the subdomains this Physics is.
Definition: physics.C:174
static std::string velocity_variable_name(const GetPot &input, const std::string &subsection_name, const SECTION_TYPE section_type)
static std::string press_variable_name(const GetPot &input, const std::string &subsection_name, const SECTION_TYPE section_type)
static std::string temp_variable_name(const GetPot &input, const std::string &subsection_name, const SECTION_TYPE section_type)
libMesh::Number _T_ref
reference temperature
static PhysicsName boussinesq_buoyancy()
const PrimitiveTempFEVariables & _temp_vars
libMesh::Number _beta_T
coefficient of thermal expansion
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().

132  {
133  std::string warning;
135  {
136  warning = "WARNING: Neither "+old_option+"\n";
137  warning += " nor a material_name was detected in input\n";
138  warning + " "+property+" is defaulting to 1.0. This behavior is DEPRECATED!\n";
139  warning += " Please update to use Material/MATERIAL_NAME/"+property+"/value\n";
140  }
141  else
142  {
143  warning = "WARNING: Neither "+old_option+"\n";
144  warning += " nor Material/"+material+"/"+property+"/value\n";
145  warning + " "+property+" is defaulting to 1.0. This behavior is DEPRECATED!\n";
146  warning += " Please update to use Material/MATERIAL_NAME/"+property+"/value\n";
147  }
148 
149  grins_warning(warning);
150  }
#define grins_warning(message)
Definition: common.h:34
static PhysicsName boussinesq_buoyancy()
static bool have_material(const GetPot &input, const std::string &physics)
Check if Physics/physics section has a material variable.
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().

86  {
88 
89  // Can't specify both material and rho_ref
91  old_option,
92  "Materials/"+material+"/"+property+"/value" );
93 
94  // Deprecated
95  if( input.have_variable(old_option) )
96  {
97  MaterialsParsing::dep_input_warning( old_option,property+"/value" );
98 
99  this->set_parameter
100  (value, input,
101  old_option, 1.0 /*Old default*/);
102  }
103  // Preferred
104  else if( input.have_variable("Materials/"+material+"/"+property+"/value" ) )
105  {
106  this->set_parameter
107  (value, input,
108  "Materials/"+material+"/"+property+"/value", 0.0 /*default*/);
109  }
110  // If nothing was set, we default to 1.0. Deprecated, what was I thinking
111  else
112  {
113  this->no_input_warning( input,
114  old_option,
115  material,
116  property );
117  this->set_parameter
118  (value, input, old_option, 1.0 /*default*/);
119  }
120 
121  // Make sure density is positive
122  if( value <= 0.0 )
123  {
124  libmesh_error_msg("ERROR: Detected non-positive "+property+"!");
125  }
126  }
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.
static PhysicsName boussinesq_buoyancy()
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.
static void dep_input_warning(const std::string &old_option, const std::string &property)
Helper function for parsing/maintaing backward compatibility.
static void duplicate_input_test(const GetPot &input, const std::string &option1, const std::string &option2)
Helper function for parsing/maintaing backward compatibility.
static std::string material_name(const GetPot &input, const std::string &physics)
Get the name of the material in the Physics/physics section.

Member Data Documentation

libMesh::Number GRINS::BoussinesqBuoyancyBase::_beta_T
protected

$ \beta_T = $ coefficient of thermal expansion

Definition at line 72 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().

const VelocityVariable& GRINS::BoussinesqBuoyancyBase::_flow_vars
protected

Definition at line 61 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().

libMesh::Point GRINS::BoussinesqBuoyancyBase::_g
protected

Gravitational vector.

Definition at line 75 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().

const PressureFEVariable& GRINS::BoussinesqBuoyancyBase::_press_var
protected

Definition at line 62 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().

libMesh::Number GRINS::BoussinesqBuoyancyBase::_rho
protected

$ \rho = $ density

Definition at line 66 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().

libMesh::Number GRINS::BoussinesqBuoyancyBase::_T_ref
protected

$ T_0 = $ reference temperature

Definition at line 69 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().

const PrimitiveTempFEVariables& GRINS::BoussinesqBuoyancyBase::_temp_vars
protected

Definition at line 63 of file boussinesq_buoyancy_base.h.

Referenced by BoussinesqBuoyancyBase().


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

Generated on Tue Dec 19 2017 12:47:30 for GRINS-0.8.0 by  doxygen 1.8.9.1