www.mooseframework.org
SmoothCircleIC.C
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 #include "SmoothCircleIC.h"
11 
12 registerMooseObject("PhaseFieldApp", SmoothCircleIC);
13 
14 template <>
15 InputParameters
17 {
18  InputParameters params = validParams<SmoothCircleBaseIC>();
19  params.addClassDescription("Circle with a smooth interface");
20  params.addRequiredParam<Real>("x1", "The x coordinate of the circle center");
21  params.addRequiredParam<Real>("y1", "The y coordinate of the circle center");
22  params.addParam<Real>("z1", 0.0, "The z coordinate of the circle center");
23  params.addRequiredParam<Real>("radius", "The radius of a circle");
24  return params;
25 }
26 
27 SmoothCircleIC::SmoothCircleIC(const InputParameters & parameters)
28  : SmoothCircleBaseIC(parameters),
29  _x1(parameters.get<Real>("x1")),
30  _y1(parameters.get<Real>("y1")),
31  _z1(parameters.get<Real>("z1")),
32  _radius(parameters.get<Real>("radius")),
33  _center(_x1, _y1, _z1)
34 {
35 }
36 
37 void
39 {
40  _radii = {_radius};
41 }
42 
43 void
45 {
46  _centers = {_center};
47 }
SmoothCircleIC::SmoothCircleIC
SmoothCircleIC(const InputParameters &parameters)
Definition: SmoothCircleIC.C:27
SmoothCircleBaseIC::_centers
std::vector< Point > _centers
Definition: SmoothCircleBaseIC.h:54
SmoothCircleIC::_radius
Real _radius
Definition: SmoothCircleIC.h:37
validParams< SmoothCircleBaseIC >
InputParameters validParams< SmoothCircleBaseIC >()
Definition: SmoothCircleBaseIC.C:18
SmoothCircleBaseIC
SmoothcircleBaseIC is the base class for all initial conditions that create circles.
Definition: SmoothCircleBaseIC.h:26
SmoothCircleIC::_center
Point _center
Definition: SmoothCircleIC.h:38
registerMooseObject
registerMooseObject("PhaseFieldApp", SmoothCircleIC)
SmoothCircleIC::computeCircleCenters
virtual void computeCircleCenters()
Definition: SmoothCircleIC.C:44
SmoothCircleBaseIC::_radii
std::vector< Real > _radii
Definition: SmoothCircleBaseIC.h:55
SmoothCircleIC::computeCircleRadii
virtual void computeCircleRadii()
Definition: SmoothCircleIC.C:38
SmoothCircleIC
SmoothcircleIC creates a circle of a given radius centered at a given point in the domain.
Definition: SmoothCircleIC.h:25
SmoothCircleIC.h
validParams< SmoothCircleIC >
InputParameters validParams< SmoothCircleIC >()
Definition: SmoothCircleIC.C:16