GRINS-0.8.0
List of all members | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes
GRINS::VelocityPenaltyBase< Viscosity > Class Template Reference

#include <velocity_penalty_base.h>

Inheritance diagram for GRINS::VelocityPenaltyBase< Viscosity >:
Inheritance graph
[legend]
Collaboration diagram for GRINS::VelocityPenaltyBase< Viscosity >:
Collaboration graph
[legend]

Public Member Functions

 VelocityPenaltyBase (const std::string &physics_name, const GetPot &input)
 
 ~VelocityPenaltyBase ()
 
void set_time_evolving_vars (libMesh::FEMSystem *system)
 Sets velocity variables to be time-evolving. More...
 
bool compute_force (const libMesh::Point &point, const AssemblyContext &context, const libMesh::NumberVectorValue &U, libMesh::NumberVectorValue &F, libMesh::NumberTensorValue *dFdU=NULL)
 
- Public Member Functions inherited from GRINS::IncompressibleNavierStokesBase< Viscosity >
 IncompressibleNavierStokesBase (const std::string &my_physics_name, const std::string &core_physics_name, const GetPot &input)
 
 ~IncompressibleNavierStokesBase ()
 
virtual void init_context (AssemblyContext &context)
 Initialize context for added physics variables. 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...
 
libMesh::Real get_viscosity_value (AssemblyContext &context, unsigned int qp) const
 
- 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 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 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...
 

Protected Attributes

std::string base_physics_name
 
bool _quadratic_scaling
 
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > normal_vector_function
 
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > base_velocity_function
 
- Protected Attributes inherited from GRINS::IncompressibleNavierStokesBase< Viscosity >
VelocityVariable_flow_vars
 
PressureFEVariable_press_var
 
libMesh::Number _rho
 Material parameters, read from input. More...
 
Viscosity _mu
 Viscosity object. 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

 VelocityPenaltyBase ()
 
void read_input_options (const GetPot &input)
 Read options from GetPot input file. More...
 

Private Attributes

const GetPot & _input
 

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

template<class Viscosity>
class GRINS::VelocityPenaltyBase< Viscosity >

Definition at line 45 of file velocity_penalty_base.h.

Constructor & Destructor Documentation

template<class Mu >
GRINS::VelocityPenaltyBase< Mu >::VelocityPenaltyBase ( const std::string &  physics_name,
const GetPot &  input 
)

Definition at line 39 of file velocity_penalty_base.C.

References GRINS::Physics::_physics_name, GRINS::VelocityPenaltyBase< Viscosity >::base_physics_name, GRINS::VelocityPenaltyBase< Viscosity >::read_input_options(), GRINS::PhysicsNaming::velocity_penalty2(), GRINS::PhysicsNaming::velocity_penalty2_adjoint_stab(), GRINS::PhysicsNaming::velocity_penalty3(), and GRINS::PhysicsNaming::velocity_penalty3_adjoint_stab().

40  : IncompressibleNavierStokesBase<Mu>(physics_name,
41  PhysicsNaming::incompressible_navier_stokes(), /* "core" Physics name */
42  input),
43  base_physics_name("VelocityPenalty"),
44  _quadratic_scaling(false),
45  _input(input)
46  {
49  base_physics_name.push_back('2');
50 
53  base_physics_name.push_back('3');
54 
55  this->read_input_options(input);
56  }
static PhysicsName velocity_penalty3_adjoint_stab()
static PhysicsName velocity_penalty2()
const PhysicsName _physics_name
Name of the physics object. Used for reading physics specific inputs.
Definition: physics.h:256
void read_input_options(const GetPot &input)
Read options from GetPot input file.
static PhysicsName incompressible_navier_stokes()
static PhysicsName velocity_penalty2_adjoint_stab()
static PhysicsName velocity_penalty3()
template<class Viscosity >
GRINS::VelocityPenaltyBase< Viscosity >::~VelocityPenaltyBase ( )
inline

Definition at line 51 of file velocity_penalty_base.h.

51 {};
template<class Viscosity >
GRINS::VelocityPenaltyBase< Viscosity >::VelocityPenaltyBase ( )
private

Member Function Documentation

template<class Mu >
bool GRINS::VelocityPenaltyBase< Mu >::compute_force ( const libMesh::Point &  point,
const AssemblyContext context,
const libMesh::NumberVectorValue &  U,
libMesh::NumberVectorValue &  F,
libMesh::NumberTensorValue *  dFdU = NULL 
)

Definition at line 92 of file velocity_penalty_base.C.

97  {
98  // Velocity discrepancy (current velocity minus base velocity)
99  // normal to constraint plane, scaled by constraint penalty
100  // value
101  libMesh::DenseVector<libMesh::Number> output_vec(3);
102 
103  (*this->normal_vector_function)(context, point, context.time, output_vec);
104 
105  libMesh::NumberVectorValue U_N(output_vec(0),
106  output_vec(1),
107  output_vec(2));
108 
109  (*this->base_velocity_function)(context, point, context.time, output_vec);
110 
111  const libMesh::NumberVectorValue U_B(output_vec(0),
112  output_vec(1),
113  output_vec(2));
114 
115  const libMesh::NumberVectorValue U_Rel = U-U_B;
116 
117  // Old code
118  // const libMesh::NumberVectorValue F1 = (U_Rel*U_N)*U_N; //
119 
120  // With correct sign and more natural normalization
121  const libMesh::Number U_N_mag = std::sqrt(U_N*U_N);
122 
123  if (!U_N_mag)
124  return false;
125 
126  const libMesh::NumberVectorValue U_N_unit = U_N/U_N_mag;
127 
128  F = -(U_Rel*U_N)*U_N_unit;
129 
130  if (dFdU)
131  for (unsigned int i=0; i != 3; ++i)
132  for (unsigned int j=0; j != 3; ++j)
133  (*dFdU)(i,j) = -(U_N(j))*U_N_unit(i);
134 
135  // With quadratic scaling
136  if (_quadratic_scaling)
137  {
138  const libMesh::Number U_Rel_mag = std::sqrt(U_Rel * U_Rel);
139 
140  // Modify dFdU first so as to reuse the old value of F
141  if (dFdU)
142  {
143  // dU_Rel/dU = I
144  // d(U_Rel*U_Rel)/dU = 2*U_Rel
145  // d|U_Rel|/dU = U_Rel/|U_Rel|
146 
147  const libMesh::NumberVectorValue U_Rel_unit = U_Rel/U_Rel_mag;
148 
149  (*dFdU) *= U_Rel_mag;
150 
151  if (U_Rel_mag)
152  for (unsigned int i=0; i != 3; ++i)
153  for (unsigned int j=0; j != 3; ++j)
154  (*dFdU)(i,j) += F(i)*U_Rel_unit(j);
155  }
156 
157  F *= U_Rel_mag;
158  }
159 
160  // With correction term to avoid doing work on flow
161  bool do_correction = false;
162  if (do_correction)
163  {
164  if (dFdU)
165  libmesh_not_implemented();
166 
167  const libMesh::Number U_Rel_mag_sq = U_Rel * U_Rel;
168  if (U_Rel_mag_sq)
169  {
170  F -= (U_Rel*F)*U_Rel/U_Rel_mag_sq;
171  }
172  }
173  return true;
174  }
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > base_velocity_function
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > normal_vector_function
template<class Mu >
void GRINS::VelocityPenaltyBase< Mu >::read_input_options ( const GetPot &  input)
private

Read options from GetPot input file.

Definition at line 59 of file velocity_penalty_base.C.

Referenced by GRINS::VelocityPenaltyBase< Viscosity >::VelocityPenaltyBase().

60  {
62  input("Physics/"+base_physics_name+"/quadratic_scaling", false);
63  }
template<class Mu >
void GRINS::VelocityPenaltyBase< Mu >::set_time_evolving_vars ( libMesh::FEMSystem *  system)
virtual

Sets velocity variables to be time-evolving.

Reimplemented from GRINS::IncompressibleNavierStokesBase< Viscosity >.

Definition at line 66 of file velocity_penalty_base.C.

67  {
70  this->normal_vector_function.reset(nvf);
71 
72  this->set_parameter(*nvf, _input,
73  "Physics/"+base_physics_name+"/penalty_function",
74  this->zero_vector_function);
75 
78  this->base_velocity_function.reset(bvf);
79 
80  this->set_parameter(*bvf, _input,
81  "Physics/"+base_physics_name+"/base_velocity",
82  this->zero_vector_function);
83 
84  if ((nvf->expression() == this->zero_vector_function) &&
85  (bvf->expression() == this->zero_vector_function))
86  std::cout << "Warning! Zero VelocityPenalty specified!" << std::endl;
87  }
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 std::string zero_vector_function
A parseable function string with LIBMESH_DIM components, all 0.
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > base_velocity_function
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > normal_vector_function

Member Data Documentation

template<class Viscosity >
const GetPot& GRINS::VelocityPenaltyBase< Viscosity >::_input
private

Definition at line 76 of file velocity_penalty_base.h.

template<class Viscosity >
bool GRINS::VelocityPenaltyBase< Viscosity >::_quadratic_scaling
protected

Definition at line 66 of file velocity_penalty_base.h.

template<class Viscosity >
std::string GRINS::VelocityPenaltyBase< Viscosity >::base_physics_name
protected
template<class Viscosity >
libMesh::UniquePtr<libMesh::FEMFunctionBase<libMesh::Number> > GRINS::VelocityPenaltyBase< Viscosity >::base_velocity_function
protected

Definition at line 72 of file velocity_penalty_base.h.

template<class Viscosity >
libMesh::UniquePtr<libMesh::FEMFunctionBase<libMesh::Number> > GRINS::VelocityPenaltyBase< Viscosity >::normal_vector_function
protected

Definition at line 69 of file velocity_penalty_base.h.


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

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