atomicrex  0.1
An advanced atomistic model building tool
PointDefectStructure.h
1 //
3 // Copyright (C) 2017, Alexander Stukowski and Paul Erhart
4 //
5 // This file is part of atomicrex.
6 //
7 // Atomicrex is free software; you can redistribute it and/or modify
8 // it under the terms of the GNU General Public License as published by
9 // the Free Software Foundation; either version 3 of the License, or
10 // (at your option) any later version.
11 //
12 // Atomicrex is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program. If not, see <http://www.gnu.org/licenses/>.
19 //
21 
22 #pragma once
23 
24 #include "SuperCellStructure.h"
25 #include "../dof/DegreeOfFreedom.h"
26 #include "../properties/FitProperty.h"
27 
28 namespace atomicrex {
29 
57 {
58 public:
59 
62 
64  virtual void updateStructure() override;
65 
67  virtual void parse(XML::Element structureElement) override;
68 
69 private:
70 
72  std::vector<int> _vacancyIndices;
73 
75  std::vector<int> _substitutionalIndices;
76  std::vector<int> _substitutionalTypes;
77 
79  std::vector<Point3> _interstitialPositions;
80  std::vector<int> _interstitialTypes;
81 };
82 
83 } // End of namespace
This class defines a N x N x N supercell structure.
Definition: SuperCellStructure.h:51
virtual void parse(XML::Element structureElement) override
Parses any structure-specific parameters in the XML element in the job file.
Definition: PointDefectStructure.cpp:87
virtual void updateStructure() override
Updates the structure (atom positions, simulation cell, etc.)
Definition: PointDefectStructure.cpp:34
PointDefectStructure(const FPString &id, FitJob *job)
Constructor.
Definition: PointDefectStructure.h:61
This file collects the definition of classes that define various simple crystal structures.
Definition: Atomicrex.h:67
This class defines point defects (vacancies, interstitials, substitutionals) in a super-cell...
Definition: PointDefectStructure.h:56
std::string FPString
The default string type used throughout the code:
Definition: Atomicrex.h:70
Definition: XMLUtilities.h:69
Definition: FitJob.h:37
FitJob * job() const
Returns a pointer to the job to which this object belongs.
Definition: FitObject.h:150