www.mooseframework.org
DiscreteNucleationForce.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "Kernel.h"
13 
14 // Forward declaration
17 
18 template <>
19 InputParameters validParams<DiscreteNucleationForce>();
20 
24 class DiscreteNucleationForce : public Kernel
25 {
26 public:
27  DiscreteNucleationForce(const InputParameters & params);
28 
29  void precalculateResidual() override;
30  Real computeQpResidual() override;
31 
32 protected:
35 
37  const std::vector<Real> * _nucleus;
38 
40  const Real _v0;
41  const Real _v1;
43 };
44 
DiscreteNucleationMap
This UserObject maintains a per QP map that indicates if a nucleus is present or not.
Definition: DiscreteNucleationMap.h:25
DiscreteNucleationForce::precalculateResidual
void precalculateResidual() override
Definition: DiscreteNucleationForce.C:38
validParams< DiscreteNucleationForce >
InputParameters validParams< DiscreteNucleationForce >()
Definition: DiscreteNucleationForce.C:17
DiscreteNucleationForce
Free energy penalty contribution to force the nucleation of subresolution particles.
Definition: DiscreteNucleationForce.h:24
DiscreteNucleationForce::_v1
const Real _v1
Definition: DiscreteNucleationForce.h:41
DiscreteNucleationForce::_nucleus
const std::vector< Real > * _nucleus
nucleus data for the current element
Definition: DiscreteNucleationForce.h:37
DiscreteNucleationForce::_map
const DiscreteNucleationMap & _map
UserObject providing a map of currently active nuclei.
Definition: DiscreteNucleationForce.h:34
DiscreteNucleationForce::DiscreteNucleationForce
DiscreteNucleationForce(const InputParameters &params)
Definition: DiscreteNucleationForce.C:29
DiscreteNucleationForce::computeQpResidual
Real computeQpResidual() override
Definition: DiscreteNucleationForce.C:45
DiscreteNucleationForce::_v0
const Real _v0
Bounds for the returned values.
Definition: DiscreteNucleationForce.h:40