gmAggregator.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2026 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_AGGREGATOR_H_
#define _GEMA_AGGREGATOR_H_
 
#include "gmCoreConfig.h"
#include "gmVector.h"
 
class GmCell;
class GmElement;
class GmValueAccessor;
class GmDiscontinuitySet;
class GmGaussAccessor;
class GmIntegrationRule;
 
enum GmAggregationType {
        GM_NO_AGGREGATION = 0,
        GM_MAX_AGGREGATION,
        GM_MIN_AGGREGATION,
        GM_ABS_MIN_AGGREGATION,
        GM_ABS_MAX_AGGREGATION,
        GM_AGGREGATION_COUNT
};
 
class GMC_API_EXPORT GmAggregator
{
public:
        static QString aggregationTypeToStr(GmAggregationType type);
        static GmAggregationType strToAggregationType(const QString& str);
 
        /*
          Aggregates values from cell's nodes or element's gauss points, 
          according to the specified aggregation type and value accessor.
 
          If a discontinuity set is given, it also requires a coordinate vector
          to be use the discontinuity aware aggregation.
          For Gauss points it may happens that with a given discontinuitySet no
          point is valid for aggregation.  
          In that case, the function should return false.
 
          Parameters:
          - GmCell* or GmElement*: the cell or element to aggregate values from
          - GmVector& result: the aggregated result is returned in this vector
          - GmAggregationType type: the type of aggregation to be performed
          - GmValueAccessor* ac: the accessor used to retrieve values for aggregation
          - GmValueAccessor* coordAc: the accessor used to retrieve coordinates for discontinuity aware aggregation (can be NULL if ds is NULL)
          - GmVector* coord: the coordinates to be used for discontinuity aware aggregation (can be NULL if ds is NULL)
          - GmDiscontinuitySet* ds: the discontinuity set to be used for aggregation (can be NULL for regular aggregation)      
        */
        static bool aggregateNode(const GmCell* c, double* result, GmAggregationType type, const GmValueAccessor* ac, 
                const GmValueAccessor* coordAc = NULL, const GmVector* coord = NULL, const GmDiscontinuitySet* ds = NULL, int dim = -1);
 
        static bool aggregateGauss(const GmElement* e, double* result, GmAggregationType type, const GmGaussAccessor* ac, 
                const GmValueAccessor* coordAc = NULL, const GmVector* coord = NULL, const GmDiscontinuitySet* ds = NULL, const GmIntegrationRule* ir = NULL, int dim = -1);
 
};
 
#endif