www.mooseframework.org
DiscreteNucleation.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
3 /* */
4 /* All contents are licensed under LGPL V2.1 */
5 /* See LICENSE for full restrictions */
6 /****************************************************************/
7 #ifndef DISCRETENUCLEATION_H
8 #define DISCRETENUCLEATION_H
9 
11 
12 // Forward declaration
13 class DiscreteNucleation;
15 
16 template <>
17 InputParameters validParams<DiscreteNucleation>();
18 
23 {
24 public:
25  DiscreteNucleation(const InputParameters & params);
26 
27  virtual void computeProperties();
28 
29 protected:
30  unsigned int _nvar;
31 
33  std::vector<unsigned int> _op_index;
34 
36  const std::vector<Real> _op_values;
37 
39  const Real _penalty;
40 
42  const unsigned int _penalty_mode;
43 
46 };
47 
48 #endif // DISCRETENUCLEATION_H
This UserObject maintains a per QP map that indicates if a nucleus is present or not.
InputParameters validParams< DiscreteNucleation >()
virtual void computeProperties()
Material base class central to compute the a phase free energy and its derivatives.
const unsigned int _penalty_mode
Match concentration exactly or use the target as a minumum or maximum value.
const Real _penalty
Nucleation free energy prefactor.
DiscreteNucleation(const InputParameters &params)
Free energy penalty contribution to force the nucleation of subresolution particles.
const DiscreteNucleationMap & _map
UserObject providing a map of currently active nuclei.
std::vector< unsigned int > _op_index
map op_names indices to _args indices
const std::vector< Real > _op_values
Target concentration values.