/ 
Photonic-0.023
River stage zero No dependents
/ Photonic::LE::NR2::Haydock

NAME

Photonic::LE::NR2::Haydock;

VERSION

version 0.023

COPYRIGHT NOTICE

Photonic - A perl package for calculations on photonics and metamaterials.

Copyright (C) 2016 by W. Luis Mochán

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA

mochan@fis.unam.mx

Instituto de Ciencias Físicas, UNAM
Apartado Postal 48-3
62251 Cuernavaca, Morelos
México

SYNOPSIS

use Photonic::LE::NR2::Haydock;
my $nr=Photonic::LE::NR2::Haydock->new(geometry=>$geometry);
$nr->iterate;
say $nr->iteration;
say $nr->current_a;
say $nr->next_b2;
my $state=$nr->next_state;

DESCRIPTION

Implements calculation of Haydock coefficients and Haydock states for the calculation of the non retarded dielectric function of arbitrary periodic two component systems in arbitrary number of dimentions. One Haydock coefficient at a time.

Consumes Photonic::Roles::Haydock, Photonic::Roles::UseMask - please see those for attributes.

ATTRIBUTES

  • geometry

    A "GeometryG0" in Photonic::Types object defining the geometry of the system, the characteristic function and the direction of the G=0 vector. Required.

  • B ndims dims r G GNorm L scale f

    Accessors handled by geometry (see Photonic::Roles::Geometry)

ATTRIBUTES SUPPLIED FOR ROLE

These are provided for roles:

  • applyOperator($psi_G)

    Apply the 'Hamiltonian' operator to state. State is nx:ny... gnorm=i:nx:ny... The operator is the longitudinal =component of the characteristic function.

  • innerProduct($left, $right)

    Returns the inner (Hermitian) product between states.

  • magnitude($psi)

    Returns the magnitude of a state as the square root of the inner =product of the state with itself.

  • changesign

    Return 0, as there is no need to change sign.

  • complexCoeffs

    Haydock coefficients are real