#include <GbMesoStateEnsemble.h>

Inheritance diagram for gbLAB::GbMesoStateEnsemble< dim >:

Public Member Functions
	GbMesoStateEnsemble (const Gb< dim > &gb, const ReciprocalLatticeVector< dim > &axis, std::vector< LatticeVector< dim > > &ensembleCslVectors, const double &bhalfMax)

std::map< Constraints, GbMesoState< dim > >	collectMesoStates (const std::string &filename="") const
	Constructs an ensemble of mesostates.

GbMesoState< dim >	constructMesoState (const Constraints &constraints) const
	Evove mesostates using a Monte Carlo algorithm.

Constraints	sampleNewState (const Constraints &currentConstraints, const bool &randomize=false) const

Constraints	initializeState () const

Public Member Functions inherited from gbLAB::GbShifts< dim >
	GbShifts (const Gb< dim > &gb, const ReciprocalLatticeVector< dim > &axis, const std::vector< LatticeVector< dim > > &gbCslVectors, const double &bhalfMax=1)

Public Member Functions inherited from gbLAB::Ensemble< XTuplet, GbMesoState< dim >, GbMesoStateEnsemble< dim > >
	Ensemble ()

GbMesoState< dim >	constructSystem (const XTuplet &state) const

std::pair< XTuplet, GbMesoState< dim > >	sampleNewState (const XTuplet &currentState)

Static Public Member Functions
static std::deque< Constraints >	enumerateConstraints (const GbShifts< dim > &gbs)

Data Fields
std::vector< LatticeVector< dim > >	ensembleCslVectors

BicrystalLatticeVectors	bicrystalConfig

Data Fields inherited from gbLAB::GbShifts< dim >
const Gb< dim > &	gb

const ReciprocalLatticeVector< dim > &	axis

const std::vector< LatticeVector< dim > >	gbCslVectors

std::vector< std::pair< LatticeVector< dim >, VectorDimD > >	bShiftPairs

Data Fields inherited from gbLAB::Ensemble< XTuplet, GbMesoState< dim >, GbMesoStateEnsemble< dim > >
const GbMesoStateEnsemble< dim > &	derived

Private Types
using	VectorDimD = typename LatticeCore< dim >::VectorDimD

using	BicrystalLatticeVectors = std::vector< LatticeVector< dim > >

using	Constraints = XTuplet

Static Private Member Functions
static BicrystalLatticeVectors	getBicrystalConfig (const GbShifts< dim > &gbs, std::vector< LatticeVector< dim > > &ensembleCslVectors)
	Constructs `bicrystalConfig` and `ensembleCslVectors`.

static std::deque< std::tuple< LatticeVector< dim >, VectorDimD, int > >	bsPairsFromConstraints (const std::vector< std::pair< LatticeVector< dim >, VectorDimD > > &bShiftPairs, const Constraints &constraints)

Additional Inherited Members
Static Protected Member Functions inherited from gbLAB::GbShifts< dim >
static std::vector< std::pair< LatticeVector< dim >, VectorDimD > >	getbShiftPairs (const Gb< dim > &gb, const std::vector< LatticeVector< dim > > &gbCslVectors, const double &bhalfMax)

Detailed Description

template<int dim>
class gbLAB::GbMesoStateEnsemble< dim >

Class template that aids in the construction of an ensemble of GB mesostates.

Definition at line 19 of file GbMesoStateEnsemble.h.

Member Typedef Documentation

◆ BicrystalLatticeVectors

template<int dim>

using gbLAB::GbMesoStateEnsemble< dim >::BicrystalLatticeVectors = std::vector<LatticeVector<dim> >

private

Definition at line 23 of file GbMesoStateEnsemble.h.

◆ Constraints

template<int dim>

using gbLAB::GbMesoStateEnsemble< dim >::Constraints = XTuplet

private

Definition at line 25 of file GbMesoStateEnsemble.h.

◆ VectorDimD

template<int dim>

using gbLAB::GbMesoStateEnsemble< dim >::VectorDimD = typename LatticeCore<dim>::VectorDimD

private

Definition at line 22 of file GbMesoStateEnsemble.h.

Constructor & Destructor Documentation

◆ GbMesoStateEnsemble()

template<int dim>

gbLAB::GbMesoStateEnsemble< dim >::GbMesoStateEnsemble	(	const Gb< dim > &	gb,
		const ReciprocalLatticeVector< dim > &	axis,
		std::vector< LatticeVector< dim > > &	ensembleCslVectors,
		const double &	bhalfMax
	)

Definition at line 12 of file GbMesoStateEnsembleImplementation.h.

Member Function Documentation

◆ bsPairsFromConstraints()

template<int dim>

std::deque< std::tuple< LatticeVector< dim >, typename GbMesoStateEnsemble< dim >::VectorDimD, int > > gbLAB::GbMesoStateEnsemble< dim >::bsPairsFromConstraints	(	const std::vector< std::pair< LatticeVector< dim >, VectorDimD > > &	bShiftPairs,
		const Constraints &	constraints
	)

staticprivate

Definition at line 59 of file GbMesoStateEnsembleImplementation.h.

◆ collectMesoStates()

template<int dim>

std::map< typename GbMesoStateEnsemble< dim >::Constraints, GbMesoState< dim > > gbLAB::GbMesoStateEnsemble< dim >::collectMesoStates ( const std::string & filename = "" ) const

Constructs an ensemble of mesostates.

Parameters

filename-

Returns: A deque of mesostates

Definition at line 78 of file GbMesoStateEnsembleImplementation.h.

◆ constructMesoState()

template<int dim>

GbMesoState< dim > gbLAB::GbMesoStateEnsemble< dim >::constructMesoState ( const Constraints & constraints ) const

Evove mesostates using a Monte Carlo algorithm.

Parameters

filename-

Returns: A deque of mesostates

Definition at line 111 of file GbMesoStateEnsembleImplementation.h.

◆ enumerateConstraints()

template<int dim>

std::deque< typename GbMesoStateEnsemble< dim >::Constraints > gbLAB::GbMesoStateEnsemble< dim >::enumerateConstraints ( const GbShifts< dim > & gbs )

static

Definition at line 240 of file GbMesoStateEnsembleImplementation.h.

◆ getBicrystalConfig()

template<int dim>

GbMesoStateEnsemble< dim >::BicrystalLatticeVectors gbLAB::GbMesoStateEnsemble< dim >::getBicrystalConfig	(	const GbShifts< dim > &	gbs,
		std::vector< LatticeVector< dim > > &	ensembleCslVectors
	)

staticprivate

Constructs bicrystalConfig and ensembleCslVectors.

Parameters

gbs	- a const reference to GBShifts<dim> object
ensembleCslVectors	(output) - the CSL vectors of the ensemble's grain boundary
scales	- an integer array (of size=`dim`) representing the scaling of the mesostate ensemble

Returns: Lattice vectors of lattices \(\mathcal A\) and \(\mathcal B\) in the ensemble's bicrystal

Definition at line 42 of file GbMesoStateEnsembleImplementation.h.

◆ initializeState()

template<int dim>

GbMesoStateEnsemble< dim >::Constraints gbLAB::GbMesoStateEnsemble< dim >::initializeState ( ) const

Definition at line 318 of file GbMesoStateEnsembleImplementation.h.

◆ sampleNewState()

template<int dim>

GbMesoStateEnsemble< dim >::Constraints gbLAB::GbMesoStateEnsemble< dim >::sampleNewState	(	const Constraints &	currentConstraints,
		const bool &	randomize = `false`
	)		const

Definition at line 285 of file GbMesoStateEnsembleImplementation.h.

Field Documentation

◆ bicrystalConfig

template<int dim>

BicrystalLatticeVectors gbLAB::GbMesoStateEnsemble< dim >::bicrystalConfig

A vector of lattice vectors in the ensemble's bicrystal.

Definition at line 50 of file GbMesoStateEnsemble.h.

◆ ensembleCslVectors

template<int dim>

std::vector<LatticeVector<dim> > gbLAB::GbMesoStateEnsemble< dim >::ensembleCslVectors

CSL vectors that define the ensemble's grain boundary region

Definition at line 45 of file GbMesoStateEnsemble.h.

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

include/Lattices/GbMesoStateEnsemble.h
include/Lattices/GbMesoStateEnsembleImplementation.h

Public Member Functions

Static Public Member Functions

Data Fields

Private Types

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BicrystalLatticeVectors

◆ Constraints

◆ VectorDimD

Constructor & Destructor Documentation

◆ GbMesoStateEnsemble()

Member Function Documentation

◆ bsPairsFromConstraints()

◆ collectMesoStates()

◆ constructMesoState()

◆ enumerateConstraints()

◆ getBicrystalConfig()

◆ initializeState()

◆ sampleNewState()

Field Documentation

◆ bicrystalConfig

◆ ensembleCslVectors