/ 
Photonic-0.024
River stage zero No dependents
/ Photonic::LE::NR2::SHChiTensor

NAME

Photonic::LE::NR2::SHChiTensor

VERSION

version 0.024

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::SHChiTensor;
my $chi=Photonic::LE::NR2::SHChiTensor->new(geometry=>$g,
        densityA=>$dA, densityB=>$dB, nh=>$nh, nhf=>$nhf,
        epsA1=>$epsA1, epsB1=>$epsB1, epsA2=>$epsA2, epsB2=>$epsB2,
        filter=>$f, filterflag=>$ff);
my $chiTensor=$chi->evaluate;

DESCRIPTION

Calculates the second harmonic susceptibility tensor for a given fixed Photonic::Geometry structure as a function of the dielectric functions of the components.

METHODS

  • new(geometry=>$g, densityA=>$da, densityB=>$db, nh=>$nh, nhf=>$nhf[, filter=>$ff][, smallH=>$smallH][, smallE=>$smallE])

    Initializes the structure.

    $g Photonic::Geometry describing the structure

    $da, $db number densities for material A and B (in which units?)

    $nh is the maximum number of Haydock coefficients to use.

    $nhf is the maximum number of Haydock coefficients for the field calculation.

    $ff is a (maybe smooth) cutoff function in reciprocal space to smothen the geometry.

    $smallH and $smallE are the criteria of convergence (default 1e-7) for haydock coefficients and continued fraction.

  • evaluate([kind=>$kind,] [mask=>$mask])

    Returns the macroscopic second Harmonic susceptibility function for a given value of the dielectric functions of the host $epsA and the particle $epsB at the fundamental 1 and second harmonic 2 frequency.

    $kind is an optional letter for testing purposes with values 'd' for dipolar contribution, 'q' for quadrupolar contribution, 'e' for external contribution (dipolar+quadrupolar), 'l' for self consistent polarization without macroscopic depolarization, 'a' for self-consistent polarization (alternative, dubious), 'el' for longitudinal projection of external polarization 'f' for full selfconsistent calculation (the default).

    Mask is a mask with ones and zeroes, to evaluate the contribution of certain regions to the susceptibility.

ACCESSORS (read only)

  • geometry

    Photonic::Geometry structure describing the geometry of the metamaterial

  • B dims r G GNorm L scale f

    Accessors handled by geometry.

  • densityA, densityB

    Dipole entities density in mediums A and B

  • nhf

    Maximum number of Haydock coefficients for field calculation

  • filter

    Optional filter to multiply by in reciprocal space

  • epsA1, epsB1, epsA2, epsB2

    Dielectric functions of components A and B at fundamental and SH frequency

  • epsL

    Value of dielectric function

  • nrshp

    Array of Photonic::LE::NR2::SHP Haydock SH polarization calculators, one for each direction

  • chiTensor

    The dielectric tensor

  • nh

    The maximum number of Haydock coefficients to use.

  • converged

    Flags that the last calculation converged before using up all coefficients

  • smallH smallE

    Criteria of convergence for Haydock coefficients and for fields. 0 means don't check.

  • reorthogonalize

    Reorthogonalize haydock flag

ACCESSORS (missing)

  • u1, u2

    Spectral variables