q3::SpinResolvedEntity Class Reference

#include <spin_resolved_entity.hpp>

Inheritance diagram for q3::SpinResolvedEntity:

Public Member Functions
virtual	~SpinResolvedEntity ()=default
bool	is_spin_polarized () const
int	number_of_spin_components () const

Protected Attributes
int	number_of_spin_components_ = 1

Detailed Description

Definition at line 17 of file spin_resolved_entity.hpp.

Constructor & Destructor Documentation

~SpinResolvedEntity()

virtual q3::SpinResolvedEntity::~SpinResolvedEntity ( )

virtualdefault

Member Function Documentation

is_spin_polarized()

bool q3::SpinResolvedEntity::is_spin_polarized ( ) const

inline

Definition at line 24 of file spin_resolved_entity.hpp.

References number_of_spin_components_.

number_of_spin_components()

int q3::SpinResolvedEntity::number_of_spin_components ( ) const

inline

Definition at line 21 of file spin_resolved_entity.hpp.

References number_of_spin_components_.

Referenced by q3::PlanewaveChargeDensity::PlanewaveChargeDensity(), and q3::PlanewaveEffectivePotential::PlanewaveEffectivePotential().

Member Data Documentation

number_of_spin_components_

int q3::SpinResolvedEntity::number_of_spin_components_ = 1

protected

Definition at line 29 of file spin_resolved_entity.hpp.

Referenced by q3::PlanewaveChargeDensity::PlanewaveChargeDensity(), q3::PlanewaveEffectivePotential::PlanewaveEffectivePotential(), q3::PlanewaveChargeDensity::get_total_charge(), q3::PlanewaveEffectivePotential::initialize_kinetic_potential(), is_spin_polarized(), q3::PlanewaveEffectivePotential::log_summary(), number_of_spin_components(), q3::PlanewaveChargeDensity::reset(), q3::PlanewaveChargeDensity::to_real_space(), q3::PlanewaveEffectivePotential::to_real_space(), q3::PlanewaveChargeDensity::to_reciprocal_space(), and q3::PlanewaveEffectivePotential::to_reciprocal_space().

---

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

• src/layer_2_quantum_system/core/spin_resolved_entity.hpp