PoPs.h File Reference

#include <statusMessageReporting.h>

Go to the source code of this file.

Classes
struct	PoP_s

Macros
#define	POPS_VERSION_MAJOR   1
#define	POPS_VERSION_MINOR   0
#define	POPS_VERSION_PATCHLEVEL   5
#define	PoPs_packageSymbol   "PoPs (properties of particles)"
#define	PoPs_packageName   PoPs_packageSymbol " (properties of particles)"

Typedefs
typedef struct PoP_s	PoP

Enumerations
enum	PoPs_errorTokens { PoPs_errorToken_Okay , PoPs_errorToken_badName , PoPs_errorToken_badIndex , PoPs_errorToken_badUnitConversion }
enum	PoPs_genre {   PoPs_genre_invalid , PoPs_genre_unknown , PoPs_genre_alias , PoPs_genre_photon ,   PoPs_genre_lepton , PoPs_genre_quark , PoPs_genre_meson , PoPs_genre_baryon ,   PoPs_genre_nucleus , PoPs_genre_atom }

Functions
const char *	PoPs_version (void)
int	PoPs_versionMajor (void)
int	PoPs_versionMinor (void)
int	PoPs_versionPatchLevel (void)
int	PoPs_register (void)
int	PoPs_readDatabase (statusMessageReporting *smr, char const *fileName)
int	PoPs_release (statusMessageReporting *smr)
PoP *	PoPs_addParticleIfNeeded (statusMessageReporting *smr, PoP *pop)
PoP *	PoPs_copyAddParticleIfNeeded (statusMessageReporting *smr, PoP *pop)
PoP *	PoPs_addAliasIfNeeded (statusMessageReporting *smr, char const *name, char const *alias)
int	PoPs_numberOfParticle (void)
int	PoPs_particleIndex (char const *name)
int	PoPs_particleIndex_smr (statusMessageReporting *smr, char const *name, char const *file, int line, char const *func)
char const *	PoPs_getName_atIndex (statusMessageReporting *smr, int index)
double	PoPs_getMassInUnitOf (statusMessageReporting *smr, char const *name, char const *unit)
double	PoPs_getMassInUnitOf_atIndex (statusMessageReporting *smr, int index, char const *unit)
enum PoPs_genre	PoPs_getGenre (statusMessageReporting *smr, char const *name)
enum PoPs_genre	PoPs_getGenre_atIndex (statusMessageReporting *smr, int index)
int	PoPs_getZ_A_l (statusMessageReporting *smr, char const *name, int *Z, int *A, int *l)
int	PoPs_getZ_A_l_atIndex (statusMessageReporting *smr, int index, int *Z, int *A, int *l)
int	PoPs_hasNucleus (statusMessageReporting *smr, char const *name, int protonIsNucleus)
int	PoPs_hasNucleus_atIndex (statusMessageReporting *smr, int index, int protonIsNucleus)
char const *	PoPs_getAtomsName (statusMessageReporting *smr, char const *name)
char const *	PoPs_getAtomsName_atIndex (statusMessageReporting *smr, int index)
int	PoPs_getAtomsIndex (statusMessageReporting *smr, char const *name)
int	PoPs_getAtomsIndex_atIndex (statusMessageReporting *smr, int index)
PoP *	PoPs_getParticle_atIndex (int index)
char const *	PoPs_genreTokenToString (enum PoPs_genre genre)
void	PoPs_print (int sorted)
void	PoPs_write (FILE *f, int sorted)
PoP *	PoP_new (statusMessageReporting *smr)
int	PoP_initialize (statusMessageReporting *smr, PoP *pop)
int	PoP_release (PoP *pop)
PoP *	PoP_free (PoP *pop)
int	PoP_copyParticle (statusMessageReporting *smr, PoP *desc, PoP *src)
PoP *	PoP_makeParticle (statusMessageReporting *smr, enum PoPs_genre genre, char const *name, double mass, char const *massUnit)
int	PoP_setZ_A_l (statusMessageReporting *smr, PoP *pop, int Z, int A, int l)
int	PoP_getIndex (PoP *pop)
char const *	PoP_getName (PoP *pop)
int	PoPs_particleReadDatabase (statusMessageReporting *smr, char const *name)
PoP *	PoPs_particleCreateLoadInfo (statusMessageReporting *smr, const char *name)
int	PoPs_particleLoadInfo (statusMessageReporting *smr, const char *name, PoP *pop)
double	PoP_getMassInUnitOf (statusMessageReporting *smr, PoP *pop, char const *unit)
PoP *	PoP_makeAlias (statusMessageReporting *smr, char const *name, char const *alias)
int	PoPs_unitConversionRatio (char const *_from, char const *_to, double *ratio)
int	lPoPs_addParticleIfNeeded (statusMessageReporting *smr, char const *name, char const *special)
int	PoPs_setBDFLS_File (char const *name)

Variables
int	PoPs_smr_ID

Macro Definition Documentation

PoPs_packageName

#define PoPs_packageName   PoPs_packageSymbol " (properties of particles)"

Definition at line 32 of file PoPs.h.

PoPs_packageSymbol

#define PoPs_packageSymbol   "PoPs (properties of particles)"

Definition at line 31 of file PoPs.h.

POPS_VERSION_MAJOR

#define POPS_VERSION_MAJOR   1

Definition at line 27 of file PoPs.h.

POPS_VERSION_MINOR

#define POPS_VERSION_MINOR   0

Definition at line 28 of file PoPs.h.

POPS_VERSION_PATCHLEVEL

#define POPS_VERSION_PATCHLEVEL   5

Definition at line 29 of file PoPs.h.

Typedef Documentation

PoP

typedef struct PoP_s PoP

Definition at line 33 of file PoPs.h.

Enumeration Type Documentation

PoPs_errorTokens

enum PoPs_errorTokens

Enumerator
PoPs_errorToken_Okay
PoPs_errorToken_badName
PoPs_errorToken_badIndex
PoPs_errorToken_badUnitConversion

Definition at line 35 of file PoPs.h.

{ PoPs_errorToken_Okay, PoPs_errorToken_badName, PoPs_errorToken_badIndex, PoPs_errorToken_badUnitConversion };

PoPs_genre

enum PoPs_genre

Enumerator
PoPs_genre_invalid
PoPs_genre_unknown
PoPs_genre_alias
PoPs_genre_photon
PoPs_genre_lepton
PoPs_genre_quark
PoPs_genre_meson
PoPs_genre_baryon
PoPs_genre_nucleus
PoPs_genre_atom

Definition at line 36 of file PoPs.h.

                { PoPs_genre_invalid, PoPs_genre_unknown, PoPs_genre_alias, PoPs_genre_photon, PoPs_genre_lepton, 
        PoPs_genre_quark, PoPs_genre_meson, PoPs_genre_baryon, PoPs_genre_nucleus, PoPs_genre_atom };

Function Documentation

lPoPs_addParticleIfNeeded()

int lPoPs_addParticleIfNeeded	(	statusMessageReporting *	smr,
		char const *	name,
		char const *	special
	)

Definition at line 36 of file lPoPs.cc.

                                                                                                    {
 
    int index = PoPs_particleIndex( name ), ZA, Z = 0, A = 0,/* level = 0,*/ ispecial;
    char *endptr, name_[256], AStr[32];
    char const *ZStr, *alias = NULL;
    PoP *pop, *pop_;
 /* enum PoPs_genre genre = PoPs_genre_unknown; */
    char const *yiNames[]   = { "p",  "h2", "h3", "he3", "he4", "photon" };
    char const *yiAliases[] = { "h1",  "d",  "t", "he3",   "a", "g" };
 /* enum PoPs_genre yiGenres[] = { PoPs_genre_baryon, PoPs_genre_nucleus, PoPs_genre_nucleus, PoPs_genre_nucleus,
        PoPs_genre_nucleus, PoPs_genre_photon }; */
 
    if( special == NULL ) special = "";
    if( index < 0 ) {
        if( isdigit( name[0] ) ) {
            ZA = (int) strtol( name, &endptr, 10 );
            if( *endptr != 0 ) {
                smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badName, "string '%s' not a value ZA", name );
                return( -1 );
            }
            Z = ZA / 1000;
            A = ZA % 1000;
            /*level = 0;*/
            ispecial = 0;
            if( strcmp( special, "LLNL" ) == 0 ) {
                if( ( ZA > 1 ) && ( ZA < 8 ) ) {
                    strcpy( name_, yiNames[ZA-2] );
                    alias = yiAliases[ZA-2];
                 /* genre = yiGenres[ZA-2];*/
                    ispecial = 1; }
                else if( ( ZA == 1801 ) || ( ZA == 1901 ) ) {
                    strcpy( name_, yiNames[0] );
                    alias = yiAliases[0];
                 /* genre = yiGenres[0]; */
                    ispecial = 1; }
                else if( ZA == 1902 ) {
                    strcpy( name_, yiNames[1] );
                    alias = yiAliases[1];
                 /* genre = yiGenres[1]; */
                    ispecial = 1; }
                else if( ZA == 4809 ) {
                    strcpy( name_, "Be9" );
                 /* genre = PoPs_genre_atom; */
                    ispecial = 1; }
                else if( ZA == 4909 ) {
                    strcpy( name_, "Be9" );
                 /* genre = PoPs_genre_atom; */
                    ispecial = 1; }
                else if( ZA == 6912 ) {
                    strcpy( name_, "C12" );
                 /* genre = PoPs_genre_atom; */
                    ispecial = 1; }
                else if( ZA == 8916 ) {
                    strcpy( name_, "O16" );
                 /* genre = PoPs_genre_atom; */
                    ispecial = 1; }
                else if( ZA == 95242 ) {
                    strcpy( name_, "Am242_e2" );
                    /*level = 2;*/
                 /* genre = PoPs_genre_atom; */
                    ispecial = 1; }
                else if( Z == 99 ) {
                    if( ( 120 <= A ) && ( A < 126 ) ) {
                        snprintf( name_, sizeof name_, "FissionProductENDL99%d", A );
                     /* genre = PoPs_genre_atom; */
                        ispecial = 1;
                    }
                }
            }
            if( ispecial == 0 ) {
                if( ZA == 1 ) {
                    AStr[0] = 0; }
                else if( A == 0 ) {
                    strcpy( AStr, "_natural" ); }
                else {
                    snprintf( AStr, sizeof AStr, "%d", A );
                }
                if( ( ZStr = lPoPs_ZSymbol( Z ) ) == NULL ) {
                    smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badName, "string '%s' not a value ZA; Z = %d is not supported", name, Z );
                    return( -1 );
                }
                snprintf( name_, sizeof name_, "%s%s", ZStr, AStr );
              /* genre = PoPs_genre_atom; */
              /* if( ZA == 1 ) genre = PoPs_genre_baryon; */
            } }
        else {
            strcpy( name_, name );
            ZA = -1;
            if( strcmp( name, "neutron" ) == 0 ) {
                strcpy( name_, "n" );
                alias = name;
            /*  genre = PoPs_genre_baryon; */ }
            else if( strcmp( name, "electron" ) == 0 ) {
                strcpy( name_, "e-" );
                alias = name;
            /*  genre = PoPs_genre_lepton; */ } 
            else if( strcmp( name, "positron" ) == 0 ) {
                strcpy( name_, "e+" );
                alias = name;
            /*  genre = PoPs_genre_lepton; */ } 
            else if( ( strcmp( name, "h1" ) == 0 ) || ( strcmp( name, "proton" ) == 0 ) ) {
                ZA = 2; }
            else if( ( strcmp( name, "d" ) == 0 ) || ( strcmp( name, "deuteron" ) == 0 ) ) {
                ZA = 3; }
            else if( ( strcmp( name, "t" ) == 0 ) || ( strcmp( name, "triton" ) == 0 ) ) {
                ZA = 4; }
            else if( strcmp( name, "helium3" ) == 0 ) {
                ZA = 5; }
            else if( ( strcmp( name, "a" ) == 0 ) || ( strcmp( name, "alpha" ) == 0 ) || ( strcmp( name, "helium4" ) == 0 ) ) {
                ZA = 6; }
            else if( ( strcmp( name, "g" ) == 0 ) || ( strcmp( name, "gamma" ) == 0 ) ) {
                ZA = 7; }
            else if( strcmp( name, "FP" ) == 0 ) {
                        strcpy( name_, "FissionProductENDL99120" );
                    /*  genre = PoPs_genre_atom; */
            }
            if( ZA != -1 ) {
                strcpy( name_, yiNames[ZA-2] );
                alias = name;
             /* genre = yiGenres[ZA-2]; */
            }
        }
 
        if( ( pop = PoPs_particleCreateLoadInfo( smr, name_ ) ) == NULL ) {
            smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badName, "particle '%s' converted to name '%s' not in database", name, name_ );
            return( -1 );
        }
        if( ( pop_ = PoPs_addParticleIfNeeded( smr, pop ) ) != pop ) PoP_free( pop );       /* Still need to add alias as index was < 0. */
        index = pop_->index;
 
        if( PoPs_particleIndex( name ) < 0 ) {
            if( ( pop = PoP_makeAlias( smr, name_, name ) ) == NULL ) return( -1 );
            if( ( pop_ = PoPs_addParticleIfNeeded( smr, pop ) ) != pop ) return( -1 );          /* pop_ should be pop as index was < 0. */
        }
 
        if( alias != NULL ) {
            if( PoPs_particleIndex( alias ) < 0 ) {
                if( ( pop = PoP_makeAlias( smr, name_, alias ) ) == NULL ) return( -1 );
                if( ( pop_ = PoPs_addParticleIfNeeded( smr, pop ) ) != pop ) return( -1 );  /* Required for some yis. */
            }
        }
    }
    return( index );
}

Referenced by MCGIDI_map_findAllOfTarget(), MCGIDI_map_findTarget(), MCGIDI_map_initialize(), MCGIDI_POPs_addParticleIfNeeded(), and PoPs_particleReadDatabase().

PoP_copyParticle()

int PoP_copyParticle	(	statusMessageReporting *	smr,
		PoP *	desc,
		PoP *	src
	)

Definition at line 567 of file PoPs.cc.

                                                                         {
 
    desc->index = -1;
    desc->properIndex = src->properIndex;
    desc->aliasIndex = src->aliasIndex;
    desc->genre = src->genre;
    if( ( desc->name = smr_allocateCopyString2( smr, src->name, "desc->name" ) ) == NULL ) return( 1 );
    desc->Z = src->Z;
    desc->A = src->A;
    desc->l = src->l;
    desc->mass = src->mass;
    desc->massUnit = src->massUnit;
 
    return( 0 );
}

Referenced by PoPs_copyAddParticleIfNeeded().

PoP_free()

PoP * PoP_free

(

PoP *

pop

)

Definition at line 558 of file PoPs.cc.

                          {
 
    PoP_release( pop );
    smr_freeMemory( (void **) &pop );
    return( NULL );
}

Referenced by lPoPs_addParticleIfNeeded(), PoP_makeAlias(), PoP_makeParticle(), PoP_new(), PoPs_addAliasIfNeeded(), PoPs_copyAddParticleIfNeeded(), PoPs_particleCreateLoadInfo(), PoPs_particleReadDatabase(), and PoPs_releasePrivate().

PoP_getIndex()

int PoP_getIndex

(

PoP *

pop

)

Definition at line 612 of file PoPs.cc.

                             {
 
    return( pop->index );
}

PoP_getMassInUnitOf()

double PoP_getMassInUnitOf	(	statusMessageReporting *	smr,
		PoP *	pop,
		char const *	unit
	)

Definition at line 626 of file PoPs.cc.

                                                                                      {
 
    double mass = -1., ratio;
    /* PoP *pop_ = pop;*/
 
    /*if( pop->genre == PoPs_genre_alias ) pop_ = popsRoot.pops[PoPs_particleProperIndex( pop->index )];*/
    if( PoPs_unitConversionRatio( pop->massUnit, unit, &ratio ) != 0 ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badUnitConversion, "could not convert unit '%s' to '%s'", pop->massUnit, unit ); }
    else {
        mass = pop->mass * ratio;
    }
 
    return( mass );
}

Referenced by PoPs_getMassInUnitOf_atIndex().

PoP_getName()

char const * PoP_getName

(

PoP *

pop

)

Definition at line 619 of file PoPs.cc.

                                    {
 
    return( pop->name );
}

PoP_initialize()

int PoP_initialize	(	statusMessageReporting *	smr,
		PoP *	pop
	)

Definition at line 533 of file PoPs.cc.

                                                           {
 
    pop->index = -1;
    pop->properIndex = -1;
    pop->aliasIndex = -1;
    pop->genre = PoPs_genre_unknown;
    pop->name = NULL;
    pop->Z = 0;
    pop->A = 0;
    pop->mass = 0.0;
    pop->massUnit = NULL;
    return( 0 );
}

Referenced by PoP_new(), and PoP_release().

PoP_makeAlias()

PoP * PoP_makeAlias	(	statusMessageReporting *	smr,
		char const *	name,
		char const *	alias
	)

Definition at line 647 of file PoPs.cc.

                                                                                       {
 
    int properIndex = PoPs_particleIndex( name ), aliasIndex = PoPs_particleIndex( alias );
    PoP *pop;
 
    if( properIndex < 0 ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badName, "proper particle '%s' not in PoPs for alias '%s'", name, alias );
        return( NULL );
    }
    if( aliasIndex >= 0 ) {     /* alias has already been defined. */
        PoP *truePop = popsRoot.pops[aliasIndex];
 
        for( pop = truePop; strcmp( alias, pop->name ); pop = popsRoot.pops[aliasIndex] ) aliasIndex = pop->aliasIndex;
        if( pop->genre != PoPs_genre_alias ) {
            smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badName, "particle '%s' already in PoPs and not an alias", alias );
            return( NULL );
        }
        if( pop->properIndex != properIndex ) {
            smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badName, "particle '%s' already an alias for '%s', cannot re-alias to '%s'", 
                alias, truePop->name, name );
            return( NULL );
        } }
    else {
        if( ( pop = PoP_new( smr ) ) == NULL ) return( NULL );
        if( ( pop->name = smr_allocateCopyString2( smr, alias, "name" ) ) == NULL ) {
            PoP_free( pop );
            return( NULL );
        }
        pop->properIndex = properIndex;
        pop->genre = PoPs_genre_alias;
    }
    return( pop );
}

Referenced by lPoPs_addParticleIfNeeded(), and PoPs_addAliasIfNeeded().

PoP_makeParticle()

PoP * PoP_makeParticle	(	statusMessageReporting *	smr,
		enum PoPs_genre	genre,
		char const *	name,
		double	mass,
		char const *	massUnit
	)

Definition at line 585 of file PoPs.cc.

                                                                                                                                 {
 
    PoP *pop;
    
    if( ( pop = PoP_new( smr ) ) == NULL ) return( NULL );
    if( ( pop->name = smr_allocateCopyString2( smr, name, "name" ) ) == NULL ) {
        PoP_free( pop );
        return( NULL );
    }
    pop->genre = genre;
    pop->mass = mass;
    if( ( pop->massUnit = unitsDB_addUnitIfNeeded( smr, massUnit ) ) == NULL ) pop = PoP_free( pop );
    return( pop );
}

PoP_new()

PoP * PoP_new

(

statusMessageReporting *

smr

)

Definition at line 522 of file PoPs.cc.

                                            {
 
    PoP *pop;
 
    if( ( pop = (PoP *) smr_malloc2( smr, sizeof( PoP ), 0, "pop" ) ) == NULL ) return( NULL );
    if( PoP_initialize( smr, pop ) != 0 ) pop = PoP_free( pop );
    return( pop );
}

Referenced by PoP_makeAlias(), PoP_makeParticle(), and PoPs_particleCreateLoadInfo().

PoP_release()

int PoP_release

(

PoP *

pop

)

Definition at line 549 of file PoPs.cc.

                            {
 
    if( pop->name != NULL ) smr_freeMemory( (void **) &(pop->name ) );
    PoP_initialize( NULL, pop );                                /* Make it clean in case someone trys to use if. */
    return( 0 );
}

Referenced by PoP_free().

PoP_setZ_A_l()

int PoP_setZ_A_l	(	statusMessageReporting *	smr,
		PoP *	pop,
		int	Z,
		int	A,
		int	l
	)

Definition at line 602 of file PoPs.cc.

                                                                              {
 
    pop->Z = Z;
    pop->A = A;
    pop->l = l;
    return( 0 );
}

PoPs_addAliasIfNeeded()

PoP * PoPs_addAliasIfNeeded	(	statusMessageReporting *	smr,
		char const *	name,
		char const *	alias
	)

Definition at line 179 of file PoPs.cc.

                                                                                               {
 
    PoP *pop = PoP_makeAlias( smr, name, alias );
 
    if( pop != NULL ) {
        if( pop->index < 0 ) {
            if( PoPs_addParticleIfNeeded( smr, pop ) == NULL ) {
                PoP_free( pop );
                return( NULL );
            }
        }
    }
    
    return( pop );
}

Referenced by MCGIDI_map_initialize().

PoPs_addParticleIfNeeded()

PoP * PoPs_addParticleIfNeeded	(	statusMessageReporting *	smr,
		PoP *	pop
	)

Definition at line 113 of file PoPs.cc.

                                                                       {
/*
    If particle with name pop->name is already in popsRoot, returns the pointer to the existing particle.
    A NULL is returned if adding particle to popsRoot fails.
*/
    int i, index = PoPs_sortedParticleIndex( pop->name );
 
    if( index >= 0 ) return( popsRoot.pops[PoPs_particleProperIndex( popsRoot.sorted[index]->index )] );
    if( popsRoot.numberOfParticles == popsRoot.allocated ) {
        int size = popsRoot.allocated + incrementalSize;
        PoP **sorted, **pops = (PoP **) smr_malloc2( smr, 2 * size * sizeof( PoPs * ), 0, "pops" );
 
        if( pops == NULL ) return( NULL );
        sorted = &(pops[size]);
        for( i = 0; i < popsRoot.numberOfParticles; i++ ) {
            pops[i] = popsRoot.pops[i];
            sorted[i] = popsRoot.sorted[i];
        }
        smr_freeMemory( (void **) &(popsRoot.pops) );
        popsRoot.pops = pops;
        popsRoot.sorted = sorted;
        popsRoot.allocated = size;
    }
    popsRoot.pops[popsRoot.numberOfParticles] = pop;
    index = -index - 1;
    for( i = popsRoot.numberOfParticles; i > index; i-- ) popsRoot.sorted[i] = popsRoot.sorted[i-1];
    popsRoot.sorted[index] = pop;
    pop->index = popsRoot.numberOfParticles;
    popsRoot.numberOfParticles++;
    if( pop->genre == PoPs_genre_alias ) {  /* Add pop->index to end of list of particles aliased by pop->properIndex. */
        PoP *pop2;
 
        for( pop2 = popsRoot.pops[pop->properIndex]; pop2->aliasIndex >= 0; pop2 = popsRoot.pops[pop2->aliasIndex] ) ;
        pop2->aliasIndex = pop->index;
    }
    return( pop );
}

Referenced by lPoPs_addParticleIfNeeded(), PoPs_addAliasIfNeeded(), PoPs_copyAddParticleIfNeeded(), and PoPs_particleReadDatabase().

PoPs_copyAddParticleIfNeeded()

PoP * PoPs_copyAddParticleIfNeeded	(	statusMessageReporting *	smr,
		PoP *	pop
	)

Definition at line 153 of file PoPs.cc.

                                                                           {
/*
    If particle with name pop->name is already in popsRoot, return the address of the existing particle.
    If particle is not in popsRoot then copy particle to a new 'PoP *', add the copied PoP to popsRoot and return its address.
    A NULL is return if particle coping fails or adding particle to popsRoot fails.
*/
 
    int index = PoPs_particleIndex( pop->name );
    PoP *newPoP;
 
    if( index >= 0 ) return( popsRoot.pops[index] );
 
    if( ( newPoP = (PoP *) smr_malloc2( smr, sizeof( PoP ), 0, "newPoP" ) ) == NULL ) return( NULL );
    if( PoP_copyParticle( smr, newPoP, pop ) ) {
        smr_freeMemory( (void **) &newPoP );
        return( NULL );
    }
    if( PoPs_addParticleIfNeeded( smr, newPoP ) == NULL ) {
        PoP_free( newPoP );
        return( NULL );
    }
    return( newPoP );
}

PoPs_genreTokenToString()

char const * PoPs_genreTokenToString

(

enum PoPs_genre

genre

)

Definition at line 446 of file PoPs.cc.

                                                             {
 
    if( genre < PoPs_genre_invalid ) return( NULL );
    if( genre > PoPs_genre_atom ) return( NULL );
    return( PoPs_genreStrings[genre] );
}

Referenced by PoPs_write().

PoPs_getAtomsIndex()

int PoPs_getAtomsIndex	(	statusMessageReporting *	smr,
		char const *	name
	)

Definition at line 397 of file PoPs.cc.

                                                                        {
 
    int index = PoPs_particleIndex_smr( smr, name, __FILE__, __LINE__, __func__ );
 
    if( index < 0 ) return( index );
    return( PoPs_getAtomsIndex_atIndex( smr, index ) );
}

PoPs_getAtomsIndex_atIndex()

int PoPs_getAtomsIndex_atIndex	(	statusMessageReporting *	smr,
		int	index
	)

Definition at line 407 of file PoPs.cc.

                                                                         {
 
    char const *p = NULL;
 
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badIndex, "index %d not in PoPs", index );
        return( -1 );
    }
 
    if( popsRoot.pops[index]->genre == PoPs_genre_atom ) return( index );
 
    if(      strcmp( "p", popsRoot.pops[index]->name ) == 0 ) {
        p = "H1"; }
    else {
        if( popsRoot.pops[index]->genre != PoPs_genre_nucleus ) return( -1 );
        else if( strcmp( "h2", popsRoot.pops[index]->name ) == 0 ) {
            p = "H2"; }
        else if( strcmp( "h3", popsRoot.pops[index]->name ) == 0 ) {
            p = "H3"; }
        else if( strcmp( "he3", popsRoot.pops[index]->name ) == 0 ) {
            p = "He3"; }
        else if( strcmp( "he4", popsRoot.pops[index]->name ) == 0 ) {
            p = "He4";
        }
    }
    if( p != NULL ) return( PoPs_particleIndex_smr( smr, p, __FILE__, __LINE__, __func__ ) );
    return( -1 );
}

Referenced by PoPs_getAtomsIndex(), and PoPs_getAtomsName_atIndex().

PoPs_getAtomsName()

char const * PoPs_getAtomsName	(	statusMessageReporting *	smr,
		char const *	name
	)

Definition at line 377 of file PoPs.cc.

                                                                               {
 
    int index = PoPs_particleIndex_smr( smr, name, __FILE__, __LINE__, __func__ );
 
    if( index < 0 ) return( NULL );
    return( PoPs_getAtomsName_atIndex( smr, index ) );
}

PoPs_getAtomsName_atIndex()

char const * PoPs_getAtomsName_atIndex	(	statusMessageReporting *	smr,
		int	index
	)

Definition at line 387 of file PoPs.cc.

                                                                                {
 
    int atomIndex = PoPs_getAtomsIndex_atIndex( smr, index );
 
    if( atomIndex < 0 ) return( NULL );
    return( popsRoot.pops[atomIndex]->name );
}

Referenced by PoPs_getAtomsName().

PoPs_getGenre()

enum PoPs_genre PoPs_getGenre	(	statusMessageReporting *	smr,
		char const *	name
	)

Definition at line 301 of file PoPs.cc.

                                                                               {
 
    int index = PoPs_particleIndex_smr( smr, name, __FILE__, __LINE__, __func__ );
 
    if( index < 0 ) return( PoPs_genre_invalid );
    return( popsRoot.pops[index]->genre );
}

PoPs_getGenre_atIndex()

enum PoPs_genre PoPs_getGenre_atIndex	(	statusMessageReporting *	smr,
		int	index
	)

Definition at line 311 of file PoPs.cc.

                                                                                {
 
    enum PoPs_genre genre = PoPs_genre_invalid;
 
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badIndex, "index %d not in PoPs", index ); }
    else {
        genre = popsRoot.pops[index]->genre;
    }
    return( genre );
}

PoPs_getMassInUnitOf()

double PoPs_getMassInUnitOf	(	statusMessageReporting *	smr,
		char const *	name,
		char const *	unit
	)

Definition at line 265 of file PoPs.cc.

                                                                                               {
 
    int index = PoPs_particleIndex_smr( smr, name, __FILE__, __LINE__, __func__ );
 
    if( index < 0 ) return( -1. );
    return( PoPs_getMassInUnitOf_atIndex( smr, index, unit ) );
}

PoPs_getMassInUnitOf_atIndex()

double PoPs_getMassInUnitOf_atIndex	(	statusMessageReporting *	smr,
		int	index,
		char const *	unit
	)

Definition at line 286 of file PoPs.cc.

                                                                                                {
 
    double mass = -1.;
 
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badIndex, "index %d not in PoPs", index ); }
    else {
        mass = PoP_getMassInUnitOf( smr, popsRoot.pops[index], unit );
    }
 
    return( mass );
}

Referenced by PoPs_getMassInUnitOf().

PoPs_getName_atIndex()

char const * PoPs_getName_atIndex	(	statusMessageReporting *	smr,
		int	index
	)

Definition at line 275 of file PoPs.cc.

                                                                           {
 
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badIndex, "index %d not in PoPs", index );
        return( NULL );
    }
    return( popsRoot.pops[index]->name );
}

Referenced by MCGIDI_map_findTargetViaPoPIDs().

PoPs_getParticle_atIndex()

PoP * PoPs_getParticle_atIndex

(

int

index

)

Definition at line 438 of file PoPs.cc.

                                           {
 
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) return( NULL );
    return( popsRoot.pops[index] );
}

PoPs_getZ_A_l()

int PoPs_getZ_A_l	(	statusMessageReporting *	smr,
		char const *	name,
		int *	Z,
		int *	A,
		int *	l
	)

Definition at line 325 of file PoPs.cc.

                                                                                           {
 
    int index = PoPs_particleIndex_smr( smr, name, __FILE__, __LINE__, __func__ );
 
    if( index < 0 ) return( -1 );
    return( PoPs_getZ_A_l_atIndex( smr, index, Z, A, l ) );
}

PoPs_getZ_A_l_atIndex()

int PoPs_getZ_A_l_atIndex	(	statusMessageReporting *	smr,
		int	index,
		int *	Z,
		int *	A,
		int *	l
	)

Definition at line 335 of file PoPs.cc.

                                                                                            {
 
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badIndex, "index %d not in PoPs", index );
        return( -1 );
    }
    *Z = popsRoot.pops[index]->Z;
    *A = popsRoot.pops[index]->A;
    *l = 0;
    return( 0 );
}

Referenced by PoPs_getZ_A_l().

PoPs_hasNucleus()

int PoPs_hasNucleus	(	statusMessageReporting *	smr,
		char const *	name,
		int	protonIsNucleus
	)

Definition at line 349 of file PoPs.cc.

                                                                                          {
 
    int index = PoPs_particleIndex_smr( smr, name, __FILE__, __LINE__, __func__ );
 
    if( index < 0 ) return( -1 );
    return( PoPs_hasNucleus_atIndex( smr, index, protonIsNucleus ) );
}

Referenced by PoPs_write().

PoPs_hasNucleus_atIndex()

int PoPs_hasNucleus_atIndex	(	statusMessageReporting *	smr,
		int	index,
		int	protonIsNucleus
	)

Definition at line 359 of file PoPs.cc.

                                                                                           {
/*
*   If an error is encountered, a negative value is returned. A value greater than 0 means the particle
*   contains a nucleus (is an atom, ion or nucleus). Otherwise, a 0 is returned.
*/
    if( ( index < 0 ) || ( index >= popsRoot.numberOfParticles ) ) {
        smr_setReportError2( smr, PoPs_smr_ID, PoPs_errorToken_badIndex, "index %d not in PoPs", index );
        return( -1 );
    }
    if( ( popsRoot.pops[index]->genre == PoPs_genre_nucleus ) || ( popsRoot.pops[index]->genre == PoPs_genre_atom ) ) return( 1 );
    if( protonIsNucleus ) {
        if( strcmp( "p", popsRoot.pops[index]->name ) == 0 ) return( 1 );
    }
    return( 0 );
}

Referenced by PoPs_hasNucleus().

PoPs_numberOfParticle()

int PoPs_numberOfParticle

(

void

)

Definition at line 197 of file PoPs.cc.

                                  {
 
    return( popsRoot.numberOfParticles );
}

PoPs_particleCreateLoadInfo()

PoP * PoPs_particleCreateLoadInfo	(	statusMessageReporting *	smr,
		const char *	name
	)

Definition at line 61 of file PoPs_data.cc.

                                                                                  {
 
    PoP *pop;
 
    if( ( pop = PoP_new( smr ) ) != NULL ) {
        if( PoPs_particleLoadInfo( smr, name, pop ) != 0 ) pop = PoP_free( pop );
    }
    return( pop );
}

Referenced by lPoPs_addParticleIfNeeded(), and PoPs_particleReadDatabase().

PoPs_particleIndex()

int PoPs_particleIndex

(

char const *

name

)

Definition at line 204 of file PoPs.cc.

                                           {
/*
    A negative number is return if particle is not in popsRoot. Else, the Id of the real (not aliased) particle is returned.
*/
    int index = PoPs_sortedParticleIndex( name );
 
    if( index >= 0 ) index = PoPs_particleProperIndex( popsRoot.sorted[index]->index );
    return( index );
}

Referenced by lPoPs_addParticleIfNeeded(), PoP_makeAlias(), PoPs_copyAddParticleIfNeeded(), and PoPs_particleIndex_smr().

PoPs_particleIndex_smr()

int PoPs_particleIndex_smr	(	statusMessageReporting *	smr,
		char const *	name,
		char const *	file,
		int	line,
		char const *	func
	)

Definition at line 216 of file PoPs.cc.

                                                                                                                          {
 
    int index = PoPs_particleIndex( name );
 
    if( index < 0 )
        smr_setReportError( smr, NULL, file, line, func, PoPs_smr_ID, PoPs_errorToken_badName, "particle '%s' not in PoPs", name );
    return( index );
}

Referenced by PoPs_getAtomsIndex(), PoPs_getAtomsIndex_atIndex(), PoPs_getAtomsName(), PoPs_getGenre(), PoPs_getMassInUnitOf(), PoPs_getZ_A_l(), and PoPs_hasNucleus().

PoPs_particleLoadInfo()

int PoPs_particleLoadInfo	(	statusMessageReporting *	smr,
		const char *	name,
		PoP *	pop
	)

Definition at line 73 of file PoPs_data.cc.

                                                                                     {
 
    int i, n = sizeof( PoPDatas ) / sizeof( PoPDatas[0] );
 
    if( ( pop->name = smr_allocateCopyString2( smr, name, "name" ) ) == NULL ) return( -1 );
    for( i = 0; i < n; i++ ) {
        if( strcmp( PoPDatas[i].name, name ) == 0 ) {
            pop->genre = PoPDatas[i].genre;
            pop->Z = PoPDatas[i].Z;
            pop->A = 0;
            if( PoPDatas[i].N >= 0 ) pop->A = pop->Z + PoPDatas[i].N;
            pop->l = PoPDatas[i].nuclearLevel;
            pop->mass = PoPs_getBDFLS_mass( name, pop, PoPDatas[i].mass );
            pop->massUnit = unitsDB_addUnitIfNeeded( smr, "amu" );
            return( 0 );
        }
    }
    smr_freeMemory( (void **) &(pop->name) );
    smr_setReportError2( smr, smr_unknownID, 1, "particle %s not in database", name );
    return( -1 );
}

Referenced by PoPs_particleCreateLoadInfo().

PoPs_particleReadDatabase()

int PoPs_particleReadDatabase	(	statusMessageReporting *	smr,
		char const *	name
	)

Definition at line 36 of file PoPs_data.cc.

                                                                             {
 
    int i1, n1 = sizeof( PoPDatas ) / sizeof( PoPDatas[0] );
    PoP *pop;
    char ZAName[32];
 
    for( i1 = 0; i1 < n1; ++i1 ) {
        if( ( pop = PoPs_particleCreateLoadInfo( smr, PoPDatas[i1].name ) ) == NULL ) return( 1 );
        if( PoPs_addParticleIfNeeded( smr, pop ) == pop ) {
            if( ( pop->genre == PoPs_genre_atom ) && ( pop->Z < 110 ) ) {
                snprintf( ZAName, sizeof ZAName, "%d%.3d", pop->Z, pop->A );
                if( lPoPs_addParticleIfNeeded( smr, ZAName, "LLNL" ) < 0 ) return( 1 );
            } }
        else {
            PoP_free( pop );
        }
        if( smr_isOk( smr ) == 0 ) return( 1 );
    }
    if( lPoPs_addParticleIfNeeded( smr, "gamma", "LLNL" ) < 0 ) return( 1 );
    if( lPoPs_addParticleIfNeeded( smr, "g", "LLNL" ) < 0 ) return( 1 );
    return( 0 );
}

Referenced by PoPs_readDatabase().

PoPs_print()

void PoPs_print

(

int

sorted

)

Definition at line 455 of file PoPs.cc.

                              {
 
    PoPs_write( stdout, sorted );
}

PoPs_readDatabase()

int PoPs_readDatabase	(	statusMessageReporting *	smr,
		char const *	fileName
	)

Definition at line 81 of file PoPs.cc.

                                                                           {
 
    return( PoPs_particleReadDatabase( smr, fileName ) );
}

PoPs_register()

int PoPs_register

(

void

)

Definition at line 73 of file PoPs.cc.

                          {
 
    if( referenceCount < 0 ) return( -1 );
    return( ++referenceCount );
}

PoPs_release()

int PoPs_release

(

statusMessageReporting *

smr

)

Definition at line 88 of file PoPs.cc.

                                                {
 
    referenceCount--;
    if( referenceCount != 0 ) return( referenceCount );
    PoPs_releasePrivate( smr );
    return( 0 );
}

PoPs_setBDFLS_File()

int PoPs_setBDFLS_File

(

char const *

name

)

Definition at line 121 of file PoPs_data.cc.

                                           {
 
#ifdef POPS_BDFLS
 
    cbdfls_file *p;
    cbdflsErrors Error;
 
    if( BDFLS_Data != NULL ) cbdflsRelease( (cbdfls_file *) BDFLS_Data );
    BDFLS_Data = NULL;
    if( name != NULL ) {
        if( ( p = cbdflsOpen( name, &Error ) ) == NULL ) return( 1 );
        BDFLS_Data = (void *) p;
    }
#else
    if( name == NULL ) BDFLS_Data = NULL;   /* Do something with name so compilers do not complain. */
#endif
    return( 0 );
}

PoPs_unitConversionRatio()

int PoPs_unitConversionRatio	(	char const *	_from,
		char const *	_to,
		double *	ratio
	)

Definition at line 748 of file PoPs.cc.

                                                                                  {
 
    int i, n = sizeof( conversions ) / sizeof( conversions[0] );
 
    *ratio = 1.;
    if( strcmp( _from, _to ) == 0 ) return( 0 );
    for( i = 0; i < n; i++ ) {
        if( strcmp( conversions[i]._from, _from ) == 0 ) {
            if( strcmp( conversions[i]._to, _to ) == 0 ) {
                *ratio = conversions[i].ratio;
                return( 0 );
            } }
        else if( strcmp( conversions[i]._to, _from ) == 0 ) {
            if( strcmp( conversions[i]._from, _to ) == 0 ) {
                *ratio = 1. / conversions[i].ratio;
                return( 0 );
            }
        }
    }
    return( 1 );
}

Referenced by PoP_getMassInUnitOf().

PoPs_version()

const char * PoPs_version

(

void

)

Definition at line 59 of file PoPs.cc.

                                 {
 
    if( versionStr[0] == 0 ) snprintf( versionStr, sizeof versionStr, "PoPs version %d.%d.%d", POPS_VERSION_MAJOR, POPS_VERSION_MINOR, POPS_VERSION_PATCHLEVEL );
    return( versionStr );
}

PoPs_versionMajor()

int PoPs_versionMajor

(

void

)

Definition at line 67 of file PoPs.cc.

{ return( POPS_VERSION_MAJOR ); }

PoPs_versionMinor()

int PoPs_versionMinor

(

void

)

Definition at line 68 of file PoPs.cc.

{ return( POPS_VERSION_MINOR ); }

PoPs_versionPatchLevel()

int PoPs_versionPatchLevel

(

void

)

Definition at line 69 of file PoPs.cc.

{ return( POPS_VERSION_PATCHLEVEL ); }

PoPs_write()

void PoPs_write	(	FILE *	f,
		int	sorted
	)

Definition at line 462 of file PoPs.cc.

                                       {
 
    int i1, properIndex;
    PoP *pop;
 
    fprintf( f, "Mass units: number of units = %d\n", unitsRoot.numberOfUnits );
    for( i1 = 0; i1 < unitsRoot.numberOfUnits; i1++ ) {
        fprintf( f, " %s", unitsRoot.unsorted[i1] );
    }
    fprintf( f, "\n\n" );
    fprintf( f, "Particles: number of particles = %d\n", popsRoot.numberOfParticles );
    fprintf( f, " name                      index   genre            mass             hasNucleus    alias info\n" );
    fprintf( f, "                                                                           Z   A l\n" );
    fprintf( f, " --------------------------------------------------------------------------------------------\n" );
    for( i1 = 0; i1 < popsRoot.numberOfParticles; i1++ ) {
        if( sorted ) {
            pop = popsRoot.sorted[i1]; }
        else {
            pop = popsRoot.pops[i1];
        }
        properIndex = PoPs_particleProperIndex( pop->index );
        fprintf( f, " %-24s %6d   %-10s %15.8e %-6s", pop->name, pop->index, PoPs_genreTokenToString( pop->genre ), 
            popsRoot.pops[properIndex]->mass, popsRoot.pops[properIndex]->massUnit );
        if( PoPs_hasNucleus( NULL, pop->name, 0 ) ) {
            fprintf( f, " T" ); }
        else {
            fprintf( f, "  " );
        }
        if( PoPs_hasNucleus( NULL, pop->name, 1 ) ) {
            fprintf( f, " T" ); }
        else {
            fprintf( f, "  " );
        }
        if( pop->Z + pop->A > 0 ) {
            fprintf( f, " %3d %3d", pop->Z, pop->A );
            if( pop->l > 0 ) {
                fprintf( f, " %d", pop->l ); }
            else {
                fprintf( f, "  " );
            } }
        else {
            fprintf( f, "          " );
        }
        if( pop->genre == PoPs_genre_alias ) {
            fprintf( f, " %s (%d)", popsRoot.pops[properIndex]->name, popsRoot.pops[properIndex]->index ); }
        else {
            int aliasIndex;
 
            for( aliasIndex = pop->aliasIndex; aliasIndex >= 0; aliasIndex = popsRoot.pops[aliasIndex]->aliasIndex ) fprintf( f, " %d", aliasIndex );
        }
        fprintf( f, "\n" );
    }
}

Referenced by PoPs_print().

Variable Documentation

PoPs_smr_ID

int PoPs_smr_ID

extern

Definition at line 35 of file PoPs.cc.

Referenced by lPoPs_addParticleIfNeeded(), PoP_getMassInUnitOf(), PoP_makeAlias(), PoPs_getAtomsIndex_atIndex(), PoPs_getGenre_atIndex(), PoPs_getMassInUnitOf_atIndex(), PoPs_getName_atIndex(), PoPs_getZ_A_l_atIndex(), PoPs_hasNucleus_atIndex(), PoPs_particleIndex_smr(), and unitsDB_stringFromIndex().