tf_metrics.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/
 
#ifndef _SOURCE_TF_METRICS_H_
#define _SOURCE_TF_METRICS_H_
 
#include "TissueForge_private.h"
#include "tfParticle.h"
#include <set>
#include <vector>
 
 
namespace TissueForge::metrics {
 
 
    CPPAPI_FUNC(FVector3) relativePosition(const FVector3 &pos, const FVector3 &origin, const bool &comp_bc=true);
 
    CPPAPI_FUNC(ParticleList) neighborhoodParticles(const FVector3 &position, const FloatP_t &dist, const bool &comp_bc=true);
 
    CPPAPI_FUNC(HRESULT) calculateVirial(
        FloatP_t *origin,
        FloatP_t radius,
        const std::set<short int> &typeIds,
        FloatP_t *tensor
    );
 
    CAPI_FUNC(HRESULT) particlesVirial(
        int32_t *parts,
        uint16_t nr_parts,
        uint32_t flags,
        FloatP_t *tensor
    );
 
    CAPI_FUNC(HRESULT) particlesRadiusOfGyration(int32_t *parts, uint16_t nr_parts, FloatP_t* result);
 
    CAPI_FUNC(HRESULT) particlesCenterOfMass(int32_t *parts, uint16_t nr_parts, FloatP_t* result);
 
    CAPI_FUNC(HRESULT) particlesCenterOfGeometry(int32_t *parts, uint16_t nr_parts, FloatP_t* result);
 
    CAPI_FUNC(HRESULT) particlesMomentOfInertia(int32_t *parts, uint16_t nr_parts, FloatP_t* result);
 
    CPPAPI_FUNC(FVector3) cartesianToSpherical(const FVector3& postion, const FVector3& origin);
 
    CAPI_FUNC(HRESULT) particleNeighbors(
        struct Particle *part,
        FloatP_t radius,
        const std::set<short int> *typeIds,
        uint16_t *nr_parts,
        int32_t **parts
    );
 
 
    std::vector<std::vector<std::vector<ParticleList> > > particleGrid(const iVector3 &shape);
 
    CAPI_FUNC(HRESULT) particleGrid(const iVector3 &shape, ParticleList *result);
 
    CPPAPI_FUNC(FVector3) eigenVals(const FMatrix3 &mat, const bool &symmetric=false);
 
    CPPAPI_FUNC(FVector4) eigenVals(const FMatrix4 &mat, const bool &symmetric=false);
 
    CPPAPI_FUNC(std::pair<FVector3, FMatrix3>) eigenVecsVals(const FMatrix3 &mat, const bool &symmetric=false);
 
    CPPAPI_FUNC(std::pair<FVector4, FMatrix4>) eigenVecsVals(const FMatrix4 &mat, const bool &symmetric=false);
 
};
 
 
#endif // _SOURCE_TF_METRICS_H_