occ Namespace Reference

Namespaces
namespace	cg
namespace	core
	fundamental functionality for linear algebra, utilities, molecules and more
namespace	constants
	definitions of scientific and math constants
namespace	log
	logging for debug output, warnings, errors etc.
namespace	parallel
	main module for functionaliity parallelism - threads etc.
namespace	io
	file input and output module including reading wavefunction files
namespace	timing
	routines for global timers, timers of sections and more
namespace	units
namespace	util
namespace	crystal
	functionality related to periodic crystal structures, space groups, symmetry operations
namespace	descriptors
namespace	dft
	functionality related to Kohn-Sham density functional theory
namespace	qm
	quantum mechanics/quantum chemistry functionality including Hartree-Fock and more
namespace	disp
	dispersion corrections
namespace	dma
namespace	driver
namespace	elastic_fit
namespace	geometry
	computational geometry functionality - marching cubes, Morton codes etc.
namespace	density
	functionality related to evaluation of electron density
namespace	gto
	evaluation Gaussian-type orbitals, their derivatives etc.
namespace	interaction
	interactions energies including CrystalExplorer model energies
namespace	ints
	Effective core potential (ECP) integrals over Cartesian Gaussians.
namespace	isosurface
namespace	main
	main module for functionaliity related to single point energies etc.
namespace	mults
namespace	numint
namespace	opt
namespace	scrf
namespace	sht
	spherical harmonic transforms
namespace	slater
	evaluation of Slater-type orbitals, their derivatives etc.
namespace	solvent
	solvation models for correction of QM methods (implicit only for now)
namespace	xdm
namespace	xtb
namespace	scf
	self-consistent field implementation

Classes
struct	MatTriple
struct	MatSix

Typedefs
using	DMatRM
using	MatRM
using	IMatRM
using	FMatRM
using	Array = Eigen::ArrayXd
using	DArray = Eigen::ArrayXd
using	CArray = Eigen::ArrayXcd
using	IArray = Eigen::ArrayXi
using	MaskArray = Eigen::Array<bool, Eigen::Dynamic, 1>
using	MaskMat = Eigen::Array<bool, Eigen::Dynamic, Eigen::Dynamic>
using	IMat = Eigen::MatrixXi
using	IMat3N = Eigen::Matrix3Xi
using	Mat = Eigen::MatrixXd
using	MatRef = Eigen::Ref<Eigen::MatrixXd>
using	MatConstRef = Eigen::Ref<const Eigen::MatrixXd>
using	Mat3N = Eigen::Matrix3Xd
using	Mat3NConstRef = Eigen::Ref<const Mat3N>
using	MatN3 = Eigen::MatrixX3d
using	MatN3ConstRef = Eigen::Ref<const MatN3>
using	Mat3 = Eigen::Matrix3d
using	Mat2 = Eigen::Matrix2d
using	Mat3RM = Eigen::Matrix<double, 3, 3, Eigen::RowMajor>
using	Mat3ConstRef = Eigen::Ref<const Mat3>
using	Mat4 = Eigen::Matrix4d
using	Mat4ConstRef = Eigen::Ref<const Mat4>
using	Mat4N = Eigen::Matrix4Xd
using	MatN4 = Eigen::MatrixX4d
using	Mat6 = Eigen::Matrix<double, 6, 6>
using	Mat6N = Eigen::Matrix<double, 6, Eigen::Dynamic>
using	CMat = Eigen::MatrixXcd
using	CMat3N = Eigen::MatrixX3cd
using	CMatN3 = Eigen::Matrix3Xcd
using	CMat3 = Eigen::Matrix3cd
using	CMat4 = Eigen::Matrix4cd
using	FMat = Eigen::MatrixXf
using	FMat3N = Eigen::Matrix3Xf
using	FMatN3 = Eigen::MatrixX3f
using	FMat3 = Eigen::Matrix3f
using	FMat4 = Eigen::Matrix3f
using	DMat = Eigen::MatrixXd
using	DMat3N = Eigen::Matrix3Xd
using	DMatN3 = Eigen::MatrixX3d
using	DMat3 = Eigen::Matrix3d
using	DMat4 = Eigen::Matrix4d
using	RowVec = Eigen::RowVectorXd
using	Vec = Eigen::VectorXd
using	RowVec3 = Eigen::RowVector3d
using	Vec3 = Eigen::Vector3d
using	Vec2 = Eigen::Vector2d
using	RowVec4 = Eigen::RowVector4d
using	Vec4 = Eigen::Vector4d
using	Vec6 = Eigen::Matrix<double, 6, 1>
using	Vec10 = Eigen::Matrix<double, 10, 1>
using	CVec = Eigen::VectorXcd
using	DVec = Eigen::VectorXd
using	DVec3 = Eigen::Vector3d
using	FVec = Eigen::VectorXf
using	FVec3 = Eigen::Vector3f
using	FVec2 = Eigen::Vector2f
using	IVec = Eigen::VectorXi
using	IVec3 = Eigen::Vector3i

Functions
void	set_data_directory (const std::string &s)
const char *	get_data_directory ()
template<typename Derived>
std::string	format_matrix (const Eigen::DenseBase< Derived > &matrix, std::string_view fmt_str="{:12.5f}")
std::string_view	version ()
	The occ release version, e.g. "0.9.6".
std::string_view	git_commit ()
	The git commit occ was built from, with a "-dirty" suffix if the checkout had uncommitted changes, or "unknown" when built outside a git checkout.
std::string	version_string ()
	"<version> (<git commit>)", for banners and output provenance.

Typedef Documentation

Array

using occ::Array = Eigen::ArrayXd

CArray

using occ::CArray = Eigen::ArrayXcd

CMat

using occ::CMat = Eigen::MatrixXcd

CMat3

using occ::CMat3 = Eigen::Matrix3cd

CMat3N

using occ::CMat3N = Eigen::MatrixX3cd

CMat4

using occ::CMat4 = Eigen::Matrix4cd

CMatN3

using occ::CMatN3 = Eigen::Matrix3Xcd

CVec

using occ::CVec = Eigen::VectorXcd

DArray

using occ::DArray = Eigen::ArrayXd

DMat

using occ::DMat = Eigen::MatrixXd

DMat3

using occ::DMat3 = Eigen::Matrix3d

DMat3N

using occ::DMat3N = Eigen::Matrix3Xd

DMat4

using occ::DMat4 = Eigen::Matrix4d

DMatN3

using occ::DMatN3 = Eigen::MatrixX3d

DMatRM

using occ::DMatRM

Initial value:

 
    Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

DVec

using occ::DVec = Eigen::VectorXd

DVec3

using occ::DVec3 = Eigen::Vector3d

FMat

using occ::FMat = Eigen::MatrixXf

FMat3

using occ::FMat3 = Eigen::Matrix3f

FMat3N

using occ::FMat3N = Eigen::Matrix3Xf

FMat4

using occ::FMat4 = Eigen::Matrix3f

FMatN3

using occ::FMatN3 = Eigen::MatrixX3f

FMatRM

using occ::FMatRM

Initial value:

 
    Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

FVec

using occ::FVec = Eigen::VectorXf

FVec2

using occ::FVec2 = Eigen::Vector2f

FVec3

using occ::FVec3 = Eigen::Vector3f

IArray

using occ::IArray = Eigen::ArrayXi

IMat

using occ::IMat = Eigen::MatrixXi

IMat3N

using occ::IMat3N = Eigen::Matrix3Xi

IMatRM

using occ::IMatRM

Initial value:

 
    Eigen::Matrix<int, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

IVec

using occ::IVec = Eigen::VectorXi

IVec3

using occ::IVec3 = Eigen::Vector3i

MaskArray

using occ::MaskArray = Eigen::Array<bool, Eigen::Dynamic, 1>

MaskMat

using occ::MaskMat = Eigen::Array<bool, Eigen::Dynamic, Eigen::Dynamic>

Mat

using occ::Mat = Eigen::MatrixXd

Mat2

using occ::Mat2 = Eigen::Matrix2d

Mat3

using occ::Mat3 = Eigen::Matrix3d

Mat3ConstRef

using occ::Mat3ConstRef = Eigen::Ref<const Mat3>

Mat3N

using occ::Mat3N = Eigen::Matrix3Xd

Mat3NConstRef

using occ::Mat3NConstRef = Eigen::Ref<const Mat3N>

Mat3RM

using occ::Mat3RM = Eigen::Matrix<double, 3, 3, Eigen::RowMajor>

Mat4

using occ::Mat4 = Eigen::Matrix4d

Mat4ConstRef

using occ::Mat4ConstRef = Eigen::Ref<const Mat4>

Mat4N

using occ::Mat4N = Eigen::Matrix4Xd

Mat6

using occ::Mat6 = Eigen::Matrix<double, 6, 6>

Mat6N

using occ::Mat6N = Eigen::Matrix<double, 6, Eigen::Dynamic>

MatConstRef

using occ::MatConstRef = Eigen::Ref<const Eigen::MatrixXd>

MatN3

using occ::MatN3 = Eigen::MatrixX3d

MatN3ConstRef

using occ::MatN3ConstRef = Eigen::Ref<const MatN3>

MatN4

using occ::MatN4 = Eigen::MatrixX4d

MatRef

using occ::MatRef = Eigen::Ref<Eigen::MatrixXd>

MatRM

using occ::MatRM

Initial value:

 
    Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

RowVec

using occ::RowVec = Eigen::RowVectorXd

RowVec3

using occ::RowVec3 = Eigen::RowVector3d

RowVec4

using occ::RowVec4 = Eigen::RowVector4d

Vec

using occ::Vec = Eigen::VectorXd

Vec10

using occ::Vec10 = Eigen::Matrix<double, 10, 1>

Vec2

using occ::Vec2 = Eigen::Vector2d

Vec3

using occ::Vec3 = Eigen::Vector3d

Vec4

using occ::Vec4 = Eigen::Vector4d

Vec6

using occ::Vec6 = Eigen::Matrix<double, 6, 1>

Function Documentation

format_matrix()

template<typename Derived>

std::string occ::format_matrix	(	const Eigen::DenseBase< Derived > &	matrix,
		std::string_view	fmt_str = "{:12.5f}" )

get_data_directory()

const char * occ::get_data_directory

(

)

git_commit()

std::string_view occ::git_commit

(

)

The git commit occ was built from, with a "-dirty" suffix if the checkout had uncommitted changes, or "unknown" when built outside a git checkout.

Captured at build time, so it is never stale.

set_data_directory()

void occ::set_data_directory

(

const std::string &

s

)

version()

std::string_view occ::version

(

)

The occ release version, e.g. "0.9.6".

version_string()

std::string occ::version_string

(

)

"<version> (<git commit>)", for banners and output provenance.