occ::crystal::SpaceGroup Class Reference

This class represents a space group. More...

#include <spacegroup.h>

Public Member Functions
	SpaceGroup ()
	Constructs a space group with only translational symmetry.
	SpaceGroup (int num)
	Constructs a space group with the given space group number.
	SpaceGroup (const std::string &symbol)
	Constructs a space group with the given space symbol.
	SpaceGroup (const std::vector< std::string > &symops)
	Constructs a space group with the list of symmetry operations in their string form, if the list of symops is not a known space group, it will still construct the object and may be used (even though it is not necessarily valid)
	SpaceGroup (const std::vector< SymmetryOperation > &symops)
	Constructs a space group with the list of symmetry operations.
int	number () const
	Returns the space group number of this space group.
const std::string &	symbol () const
	Returns the Hermann-Mauguin (international tables) symbol for this object.
const std::string &	short_name () const
	Returns the Hermann-Mauguin (international tables) symbol for this object, shortened e.g P 1 2 1 -> P2.
const std::vector< SymmetryOperation > &	symmetry_operations () const
	Returns the list of symmetry operations for this space group.
bool	has_H_R_choice () const
	Determine whether this space group has the choice between hexagonal (H) and rhombohedral (R) settings.
std::pair< IVec, Mat3N >	apply_all_symmetry_operations (const Mat3N &) const
	Apply all symmetry operations to a provided set of fractional coordinates, with the identity symop always first.
std::pair< IVec, Mat3N >	apply_rotations (const Mat3N &) const
auto	reciprocal_asu () const

Detailed Description

This class represents a space group.

A space group describes the symmetries within a crystal structure of a crystal structure. Provides methods for accessing and manipulating space group data.

Constructor & Destructor Documentation

SpaceGroup() [1/5]

occ::crystal::SpaceGroup::SpaceGroup

(

)

Constructs a space group with only translational symmetry.

SpaceGroup() [2/5]

occ::crystal::SpaceGroup::SpaceGroup

(

int

num

)

Constructs a space group with the given space group number.

Parameters

num	The space group number.

Exceptions

std::invalid_argument

if the given number is not a valid space group number.

SpaceGroup() [3/5]

occ::crystal::SpaceGroup::SpaceGroup

(

const std::string &

symbol

)

Constructs a space group with the given space symbol.

Parameters

symbol

The space group symbol.

Exceptions

std::invalid_argument

if the given space group can't be found

SpaceGroup() [4/5]

occ::crystal::SpaceGroup::SpaceGroup

(

const std::vector< std::string > &

symops

)

Constructs a space group with the list of symmetry operations in their string form, if the list of symops is not a known space group, it will still construct the object and may be used (even though it is not necessarily valid)

Parameters

symops

The space group symmetry operations

SpaceGroup() [5/5]

occ::crystal::SpaceGroup::SpaceGroup

(

const std::vector< SymmetryOperation > &

symops

)

Constructs a space group with the list of symmetry operations.

if the list of symops is not a known space group, it will still construct the object and may be used (even though it is not necessarily valid)

Parameters

symops

The space group symmetry operations

Member Function Documentation

apply_all_symmetry_operations()

std::pair< IVec, Mat3N > occ::crystal::SpaceGroup::apply_all_symmetry_operations

(

const Mat3N &

)

const

Apply all symmetry operations to a provided set of fractional coordinates, with the identity symop always first.

Returns

a pair of IVec, Mat3N corresponding to the integer representation SymmetryOperation::to_int of the symop applied to each point, and the points after that symop application. If N points were provided and this SpaceGroup has 8 symmetry operations, then the resulting IVec will have dimension (N*8,) and the Mat3N of coordinates will have dimension (3, N*8).

apply_rotations()

std::pair< IVec, Mat3N > occ::crystal::SpaceGroup::apply_rotations

(

const Mat3N &

)

const

has_H_R_choice()

bool occ::crystal::SpaceGroup::has_H_R_choice

(

)

const

Determine whether this space group has the choice between hexagonal (H) and rhombohedral (R) settings.

Returns

true if there's a choice to be made, false otherwise

number()

int occ::crystal::SpaceGroup::number

(

)

const

Returns the space group number of this space group.

Returns

The space group number.

reciprocal_asu()

auto occ::crystal::SpaceGroup::reciprocal_asu ( ) const

inline

short_name()

const std::string & occ::crystal::SpaceGroup::short_name

(

)

const

Returns the Hermann-Mauguin (international tables) symbol for this object, shortened e.g P 1 2 1 -> P2.

Returns

The space group name.

symbol()

const std::string & occ::crystal::SpaceGroup::symbol

(

)

const

Returns the Hermann-Mauguin (international tables) symbol for this object.

Returns

The space group symbol.

symmetry_operations()

const std::vector< SymmetryOperation > & occ::crystal::SpaceGroup::symmetry_operations

(

)

const

Returns the list of symmetry operations for this space group.

Returns

The list of symmetry operations.

---

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

• /home/runner/work/occ/occ/include/occ/crystal/spacegroup.h