/ 
Photonic-0.021
River stage zero No dependents
/ Photonic::WE::R2::Haydock

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

NAME

Photonic::WE::R2::Haydock

VERSION

version 0.021

SYNOPSIS

use Photonic::WE::R2::Haydock;
my $nr=Photonic::WE::R2::Haydock->new(metric=>$g, polarization=>$p);
$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 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

  • metric

    A Photonic::Metric::R2 object defining the geometry of the system, the characteristic function, the wavenumber, wavevector and host dielectric function. Required in the initializer.

  • B ndims dims epsilon

    Accessors handled by metric (see Photonic::Metric::R2)

  • polarization

    A non null vector defining the complex direction of the macroscopic field.

METHODS

  • applyMetric($psi)

    Returns the result of applying the metric 'g' to the state; $psi.

ATTRIBUTES SUPPLIED FOR ROLE

  • applyOperator($psi_G)

    Apply the Hamiltonian operator to state. The Hamiltonian is Bg, with g the metric and B the characteristic function. Also applies an optional mask in reciprocal space.

  • innerProduct($left, $right)

    Returns the inner Hermitian product between states using the metric.

  • $s=magnitude($psi)

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

  • changesign

    Returns 1 if sign change is required to ensure b^2 is positive.