aboutsummaryrefslogtreecommitdiff
path: root/Python/pywarpx/Constants.py
blob: 1ae1dda0d77bb83a9c23bab540f12d863163621c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Copyright 2018-2019 David Grote
#
# This file is part of WarpX.
#
# License: BSD-3-Clause-LBNL

import re

from .Bucket import Bucket

class Constants(Bucket):
    """
    The purpose of this class is to be hold user defined constants
    """
    def __init__(self):
        Bucket.__init__(self, 'my_constants')

    def __setattr__(self, name, value):
        # Make sure that any constants redefined have a consistent value
        if name in self.argvattrs:
            assert self.argvattrs[name] == value, Exception('Inconsistent values given for user defined constants')
        Bucket.__setattr__(self, name, value)

    def add_keywords(self, kwdict):
        mangle_dict = {}
        for k,v in kwdict.items():
            # Check if keyword has already been defined
            # WarpX has a single global dictionary of expression variables so each
            # variable must be unique
            if k in self.argvattrs:
                # if so, mangle the name by appending a numerical suffix
                mangle_number = 1
                k_mangled = f'{k}{mangle_number}'
                while k_mangled in self.argvattrs:
                    # make sure that the mangled name has also not already been defined
                    mangle_number += 1
                    k_mangled = f'{k}{mangle_number}'
                mangle_dict[k] = k_mangled
                k = k_mangled
            setattr(self, k, v)
        return mangle_dict

    def mangle_expression(self, expression, mangle_dict):
        if expression is None:
            return None
        # For each key in mangle_dict, modify the expression replacing
        # the key with its value, the mangled version of key
        for k,v in mangle_dict.items():
            expression = re.sub(r'\b%s\b'%k, v, expression)
        return expression


my_constants = Constants()