PolyFEM
Loading...
Searching...
No Matches
polyfem::varform::FluidVarForm Class Reference

#include <FluidVarForm.hpp>

Inheritance diagram for polyfem::varform::FluidVarForm:
[legend]
Collaboration diagram for polyfem::varform::FluidVarForm:
[legend]

Public Member Functions

void init (const std::string &formulation, const Units &units, const json &args, const std::string &out_path) override
 Initialize the variational formulation with the given parameters.
 
void save_json (const Eigen::MatrixXd &solution, std::ostream &out) const override
 Save the solution to a JSON file, for output purposes.
 
void export_data (const Eigen::MatrixXd &solution) const override
 
io::OutputSpace output_space () const override
 Get the output space of the variational formulation, for output purposes.
 
io::OutStatsData compute_errors (const Eigen::MatrixXd &solution) override
 Get the error statistics of the variational formulation, for output purposes.
 
std::vector< io::OutputFieldoutput_fields (const io::OutputSample &sample, const Eigen::MatrixXd &solution, const io::OutputFieldOptions &options) const override
 Get the output fields of the variational formulation, for output purposes.
 
- Public Member Functions inherited from polyfem::varform::VarForm
virtual ~VarForm ()=default
 
virtual std::string name () const =0
 Get the name of the variational formulation.
 
void set_args (const json &args)
 Reset the internal state of the variational formulation, e.g.
 
void set_mesh (std::unique_ptr< mesh::Mesh > mesh, const double loading_mesh_time=0)
 Set the mesh for the variational formulation.
 
void solve (Eigen::MatrixXd &sol)
 Solve the variational formulation and store the solution in the given matrix.
 
void set_time_callback (const std::function< void(int, int, double, double)> &callback)
 
int problem_dimension () const
 Get the problem dimension of the variational formulation, for output purposes.
 
virtual bool is_contact_enabled () const
 Check if contact is enabled for the variational formulation, for output purposes.
 
const io::OutRuntimeDataoutput_timings () const
 Get the runtime timings of the variational formulation, for output purposes.
 
void save_json (const Eigen::MatrixXd &solution) const
 Save the solution to a JSON file, for output purposes.
 

Protected Member Functions

void reset () override
 
void load_mesh (const mesh::Mesh &mesh, const json &args) override
 
void build_basis (mesh::Mesh &mesh, const bool iso_parametric, const json &args) override
 
void assemble_rhs (const mesh::Mesh &mesh) override
 
void assemble_mass_mat (const mesh::Mesh &mesh, const json &args) override
 
int primary_ndof () const
 
int pressure_block_size () const
 
int stacked_ndof () const
 
void prepare_initial_solution (Eigen::MatrixXd &sol) const
 
void split_solution (const Eigen::MatrixXd &stacked, Eigen::MatrixXd &primary, Eigen::MatrixXd &pressure) const
 
void build_stiffness_mat (StiffnessMatrix &stiffness)
 
void solve_linear_system (const std::unique_ptr< polysolve::linear::Solver > &solver, StiffnessMatrix &A, Eigen::VectorXd &b, const bool compute_spectrum, Eigen::MatrixXd &sol)
 
void build_rhs_assembler () override
 
- Protected Member Functions inherited from polyfem::varform::VarForm
std::string resolve_output_path (const std::string &path) const
 
std::string resolve_input_path (const std::string &path, const bool only_if_exists=false) const
 
void set_materials (assembler::Assembler &assembler, const int size) const
 
void assign_discr_orders (const json &discr_order, const mesh::Mesh &mesh, Eigen::VectorXi &disc_orders)
 
virtual void solve_problem (Eigen::MatrixXd &sol)=0
 
void prepare ()
 
QuadratureOrders n_boundary_samples (const int discr_order, const int gdiscr_order) const
 
void build_fe_space (mesh::Mesh &mesh, const bool iso_parametric, const Eigen::VectorXi &disc_orders, const std::string &basis_type, const std::string &poly_basis_type, const assembler::Assembler &space_assembler, const int value_dim, const int quadrature_order, const int mass_quadrature_order, const bool use_corner_quadrature, const int n_harmonic_samples, const int integral_constraints, FESpace &space, VarFormBoundaryState &boundary, std::shared_ptr< GeometryMapping > geometry=nullptr)
 
std::shared_ptr< time_integrator::BDFmake_bdf_time_integrator () const
 
void save_step_state (const double t0, const double dt, const int t, const time_integrator::ImplicitTimeIntegrator *time_integrator, const bool rest_mesh_written=false) const
 
void ensure_output_sampler () const
 
void save_restart_json (const double t0, const double dt, const int t, const bool rest_mesh_written) const
 
void save_timestep (const double time, const int t, const double t0, const double dt, const Eigen::MatrixXd &solution) const
 
void save_subsolve (const int i, const int t, const Eigen::MatrixXd &solution) const
 
int output_file_index (const int t) const
 
void notify_time_step (const int t, const int time_steps, const double t0, const double dt) const
 
io::OutGeometryData::ExportOptions export_options (const io::OutputSpace &space) const
 
io::OutputFieldFunction output_field_function (const Eigen::MatrixXd &solution, const io::OutGeometryData::ExportOptions &opts) const
 

Protected Attributes

FESpace space_
 
FESpace pressure_space_
 
VarFormBoundaryState boundary_
 
VarFormBoundaryState pressure_boundary_
 
assembler::AssemblyValsCache ass_vals_cache_
 
assembler::AssemblyValsCache pressure_ass_vals_cache_
 
assembler::AssemblyValsCache mass_ass_vals_cache_
 
assembler::AssemblyValsCache pure_mass_ass_vals_cache_
 
std::shared_ptr< assembler::RhsAssemblerrhs_assembler_
 
StiffnessMatrix mass_
 
StiffnessMatrix pure_mass_
 
double avg_mass_ = 0
 
Eigen::MatrixXd rhs_
 
std::shared_ptr< assembler::Assemblerprimary_assembler_ = nullptr
 
std::shared_ptr< assembler::Massmass_assembler_ = nullptr
 
std::shared_ptr< assembler::HRZMasspure_mass_assembler_ = nullptr
 
std::shared_ptr< assembler::MixedAssemblermixed_assembler_ = nullptr
 
std::shared_ptr< assembler::Assemblerpressure_assembler_ = nullptr
 
bool use_avg_pressure = true
 
double t0 = 0
 
int time_steps = 0
 
double dt = 0
 
std::shared_ptr< time_integrator::ImplicitTimeIntegratortime_integrator
 
- Protected Attributes inherited from polyfem::varform::VarForm
std::shared_ptr< assembler::Problemproblem
 current problem, it contains rhs and bc
 
Units units
 
json args
 
io::OutStatsData stats
 
io::OutRuntimeData timings
 runtime statistics
 
std::string root_path
 
std::string output_path
 
std::unique_ptr< mesh::Meshmesh_
 
std::function< void(int, int, double, double)> time_callback
 
io::OutGeometryData output_geometry_
 
bool output_sampler_initialized_ = false
 
bool prepared_ = false
 

Friends

class polyfem::test::VarFormTestAccess
 

Additional Inherited Members

- Static Protected Member Functions inherited from polyfem::varform::VarForm
static bool read_initial_x_from_file (const std::string &state_path, const std::string &x_name, const bool reorder, const Eigen::VectorXi &in_node_to_node, const int dim, Eigen::MatrixXd &x)
 
static void rebuild_node_positions (const std::vector< basis::ElementBases > &bases, const std::vector< int > &node_ids, std::vector< RowVectorNd > &positions)
 

Detailed Description

Definition at line 15 of file FluidVarForm.hpp.

Member Function Documentation

◆ assemble_mass_mat()

◆ assemble_rhs()

void polyfem::varform::FluidVarForm::assemble_rhs ( const mesh::Mesh mesh)
overrideprotectedvirtual

◆ build_basis()

void polyfem::varform::FluidVarForm::build_basis ( mesh::Mesh mesh,
const bool  iso_parametric,
const json args 
)
overrideprotectedvirtual

Implements polyfem::varform::VarForm.

Definition at line 306 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::args, ass_vals_cache_, polyfem::varform::VarForm::assign_discr_orders(), polyfem::varform::FESpace::bases, polyfem::varform::FESpace::basis_list(), boundary_, polyfem::varform::VarFormBoundaryState::boundary_nodes, polyfem::varform::VarForm::build_fe_space(), build_rhs_assembler(), polyfem::varform::VarFormBoundaryState::clear_boundary_conditions(), polyfem::io::OutStatsData::compute_mesh_size(), polyfem::io::OutStatsData::count_flipped_elements(), polyfem::mesh::Mesh::dimension(), polyfem::varform::VarFormBoundaryState::dirichlet_nodes, polyfem::varform::VarFormBoundaryState::dirichlet_nodes_position, polyfem::varform::FESpace::disc_orders, polyfem::varform::FESpace::geometry, polyfem::varform::FESpace::geometry_basis_list(), polyfem::assembler::AssemblyValsCache::init(), polyfem::assembler::AssemblyValsCache::init_empty(), polyfem::mesh::Mesh::is_volume(), polyfem::varform::VarFormBoundaryState::local_boundary, polyfem::varform::VarFormBoundaryState::local_neumann_boundary, polyfem::varform::VarFormBoundaryState::local_pressure_boundary, polyfem::varform::VarFormBoundaryState::local_pressure_cavity, polyfem::log_and_throw_error(), polyfem::logger(), mass_ass_vals_cache_, mass_assembler_, polyfem::io::OutStatsData::mesh_size, polyfem::varform::FESpace::n_bases, polyfem::mesh::Mesh::n_elements(), polyfem::io::OutStatsData::n_flipped, polyfem::varform::VarFormBoundaryState::neumann_nodes, polyfem::varform::VarFormBoundaryState::neumann_nodes_position, polyfem::varform::VarFormBoundaryState::normalize_boundary_nodes(), polyfem::refinement::APriori::p_refine(), polyfem::varform::FESpace::poly_edge_to_data, pressure_ass_vals_cache_, pressure_boundary_, pressure_space_, primary_assembler_, polyfem::varform::VarForm::problem, pure_mass_ass_vals_cache_, pure_mass_assembler_, polyfem::varform::VarForm::rebuild_node_positions(), space_, polyfem::varform::FESpace::space_in_node_to_node, polyfem::varform::VarForm::stats, polyfem::varform::VarFormBoundaryState::total_local_boundary, polyfem::mesh::Mesh::update_nodes(), and use_avg_pressure.

Here is the call graph for this function:

◆ build_rhs_assembler()

void polyfem::varform::FluidVarForm::build_rhs_assembler ( )
overrideprotectedvirtual

Implements polyfem::varform::VarForm.

Definition at line 290 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::args, polyfem::varform::FESpace::basis_list(), boundary_, polyfem::varform::VarFormBoundaryState::dirichlet_nodes, polyfem::varform::VarFormBoundaryState::dirichlet_nodes_position, polyfem::varform::FESpace::geometry_basis_list(), mass_ass_vals_cache_, polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::n_bases, polyfem::varform::VarFormBoundaryState::neumann_nodes, polyfem::varform::VarFormBoundaryState::neumann_nodes_position, primary_assembler_, polyfem::varform::VarForm::problem, rhs_assembler_, and space_.

Referenced by assemble_rhs(), and build_basis().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ build_stiffness_mat()

◆ compute_errors()

io::OutStatsData polyfem::varform::FluidVarForm::compute_errors ( const Eigen::MatrixXd &  solution)
overridevirtual

Get the error statistics of the variational formulation, for output purposes.

Returns
Error statistics

Implements polyfem::varform::VarForm.

Definition at line 161 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::args, polyfem::varform::FESpace::basis_list(), polyfem::io::OutStatsData::compute_errors(), polyfem::varform::FESpace::geometry_basis_list(), polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::n_bases, polyfem::varform::VarForm::problem, space_, split_solution(), and polyfem::varform::VarForm::stats.

Here is the call graph for this function:

◆ export_data()

◆ init()

void polyfem::varform::FluidVarForm::init ( const std::string &  formulation,
const Units units,
const json args,
const std::string &  out_path 
)
overridevirtual

Initialize the variational formulation with the given parameters.

Parameters
formulationname of the variational formulation
unitsunit system to use for the formulation
argsjson input arguments, used to initialize the formulation
out_pathoutput path for the formulation, used to save intermediate data

Reimplemented from polyfem::varform::VarForm.

Definition at line 57 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::args, dt, polyfem::problem::ProblemFactory::factory(), polyfem::problem::ProblemFactory::get_problem(), polyfem::varform::VarForm::init(), polyfem::assembler::AssemblerUtils::make_assembler(), polyfem::assembler::AssemblerUtils::make_mixed_assembler(), mass_assembler_, mixed_assembler_, polyfem::assembler::AssemblerUtils::other_assembler_name(), pressure_assembler_, primary_assembler_, polyfem::varform::VarForm::problem, pure_mass_assembler_, polyfem::varform::VarForm::root_path, t0, time_steps, and polyfem::varform::VarForm::units.

Here is the call graph for this function:

◆ load_mesh()

void polyfem::varform::FluidVarForm::load_mesh ( const mesh::Mesh mesh,
const json args 
)
overrideprotectedvirtual

Implements polyfem::varform::VarForm.

Definition at line 262 of file FluidVarForm.cpp.

References polyfem::mesh::Mesh::dimension(), mass_assembler_, mixed_assembler_, pressure_assembler_, primary_assembler_, polyfem::varform::VarForm::problem, pure_mass_assembler_, and polyfem::varform::VarForm::set_materials().

Here is the call graph for this function:

◆ output_fields()

std::vector< io::OutputField > polyfem::varform::FluidVarForm::output_fields ( const io::OutputSample sample,
const Eigen::MatrixXd &  solution,
const io::OutputFieldOptions options 
) const
overridevirtual

Get the output fields of the variational formulation, for output purposes.

Parameters
sampleOutput sample
solutionSolution matrix
optionsOutput field options
Returns
Output fields

Implements polyfem::varform::VarForm.

Definition at line 648 of file FluidVarForm.cpp.

References polyfem::varform::FESpace::basis_list(), polyfem::io::OutputSample::element_ids, polyfem::io::OutputFieldOptions::export_field(), polyfem::io::OutputFieldOptions::fields, polyfem::varform::FESpace::geometry_basis_list(), polyfem::io::Evaluator::interpolate_at_local_vals(), polyfem::io::OutputSample::local_points, polyfem::varform::VarForm::mesh_, polyfem::io::OutputSample::node_ids, polyfem::io::OutputField::Point, polyfem::io::OutputSample::points, polyfem::varform::VarForm::problem, space_, and split_solution().

Here is the call graph for this function:

◆ output_space()

io::OutputSpace polyfem::varform::FluidVarForm::output_space ( ) const
overridevirtual

Get the output space of the variational formulation, for output purposes.

Returns
Output space

Implements polyfem::varform::VarForm.

Definition at line 136 of file FluidVarForm.cpp.

References boundary_, polyfem::varform::VarFormBoundaryState::dirichlet_nodes, polyfem::varform::VarFormBoundaryState::dirichlet_nodes_position, polyfem::varform::FESpace::disc_orders, polyfem::varform::FESpace::disc_ordersq, polyfem::varform::FESpace::geometry_basis_list(), polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::polys, polyfem::varform::FESpace::polys_3d, space_, and polyfem::varform::VarFormBoundaryState::total_local_boundary.

Referenced by export_data().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ prepare_initial_solution()

void polyfem::varform::FluidVarForm::prepare_initial_solution ( Eigen::MatrixXd &  sol) const
protected

◆ pressure_block_size()

int polyfem::varform::FluidVarForm::pressure_block_size ( ) const
protected

Definition at line 280 of file FluidVarForm.cpp.

References polyfem::varform::FESpace::n_bases, pressure_space_, primary_assembler_, and use_avg_pressure.

Referenced by assemble_rhs(), prepare_initial_solution(), and stacked_ndof().

Here is the caller graph for this function:

◆ primary_ndof()

int polyfem::varform::FluidVarForm::primary_ndof ( ) const
protected

Definition at line 275 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::n_bases, and space_.

Referenced by assemble_mass_mat(), export_data(), save_json(), solve_linear_system(), split_solution(), and stacked_ndof().

Here is the caller graph for this function:

◆ reset()

◆ save_json()

void polyfem::varform::FluidVarForm::save_json ( const Eigen::MatrixXd &  solution,
std::ostream &  out 
) const
overridevirtual

Save the solution to a JSON file, for output purposes.

Parameters
solutionSolution matrix to save
outOutput stream to save the solution

Implements polyfem::varform::VarForm.

Definition at line 107 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::args, polyfem::varform::FESpace::disc_orders, polyfem::varform::FESpace::disc_ordersq, polyfem::varform::FESpace::is_iso_parametric(), polyfem::logger(), polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::n_bases, polyfem::varform::VarForm::name(), pressure_space_, primary_assembler_, primary_ndof(), polyfem::varform::VarForm::problem, polyfem::io::OutStatsData::save_json(), space_, polyfem::varform::VarForm::stats, and polyfem::varform::VarForm::timings.

Here is the call graph for this function:

◆ solve_linear_system()

void polyfem::varform::FluidVarForm::solve_linear_system ( const std::unique_ptr< polysolve::linear::Solver > &  solver,
StiffnessMatrix A,
Eigen::VectorXd &  b,
const bool  compute_spectrum,
Eigen::MatrixXd &  sol 
)
protected

Definition at line 618 of file FluidVarForm.cpp.

References polyfem::varform::VarForm::args, boundary_, polyfem::varform::VarFormBoundaryState::boundary_nodes, polyfem::logger(), primary_ndof(), polyfem::io::OutStatsData::solver_info, polyfem::io::OutStatsData::spectrum, polyfem::varform::VarForm::stats, use_avg_pressure, and x.

Here is the call graph for this function:

◆ split_solution()

void polyfem::varform::FluidVarForm::split_solution ( const Eigen::MatrixXd &  stacked,
Eigen::MatrixXd &  primary,
Eigen::MatrixXd &  pressure 
) const
protected

Definition at line 573 of file FluidVarForm.cpp.

References polyfem::varform::FESpace::n_bases, pressure_space_, and primary_ndof().

Referenced by compute_errors(), export_data(), and output_fields().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ stacked_ndof()

int polyfem::varform::FluidVarForm::stacked_ndof ( ) const
protected

Definition at line 285 of file FluidVarForm.cpp.

References pressure_block_size(), and primary_ndof().

Referenced by prepare_initial_solution().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ polyfem::test::VarFormTestAccess

friend class polyfem::test::VarFormTestAccess
friend

Definition at line 17 of file FluidVarForm.hpp.

Member Data Documentation

◆ ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::FluidVarForm::ass_vals_cache_
protected

Definition at line 60 of file FluidVarForm.hpp.

Referenced by build_basis(), build_stiffness_mat(), and reset().

◆ avg_mass_

double polyfem::varform::FluidVarForm::avg_mass_ = 0
protected

Definition at line 70 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), and reset().

◆ boundary_

VarFormBoundaryState polyfem::varform::FluidVarForm::boundary_
protected

◆ dt

double polyfem::varform::FluidVarForm::dt = 0
protected

Definition at line 81 of file FluidVarForm.hpp.

Referenced by export_data(), init(), and reset().

◆ mass_

StiffnessMatrix polyfem::varform::FluidVarForm::mass_
protected

Definition at line 67 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), and reset().

◆ mass_ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::FluidVarForm::mass_ass_vals_cache_
protected

Definition at line 62 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), build_basis(), build_rhs_assembler(), and reset().

◆ mass_assembler_

std::shared_ptr<assembler::Mass> polyfem::varform::FluidVarForm::mass_assembler_ = nullptr
protected

Definition at line 74 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), assemble_rhs(), build_basis(), init(), load_mesh(), and reset().

◆ mixed_assembler_

std::shared_ptr<assembler::MixedAssembler> polyfem::varform::FluidVarForm::mixed_assembler_ = nullptr
protected

Definition at line 76 of file FluidVarForm.hpp.

Referenced by build_stiffness_mat(), init(), load_mesh(), and reset().

◆ pressure_ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::FluidVarForm::pressure_ass_vals_cache_
protected

Definition at line 61 of file FluidVarForm.hpp.

Referenced by build_basis(), build_stiffness_mat(), and reset().

◆ pressure_assembler_

std::shared_ptr<assembler::Assembler> polyfem::varform::FluidVarForm::pressure_assembler_ = nullptr
protected

Definition at line 77 of file FluidVarForm.hpp.

Referenced by build_stiffness_mat(), init(), load_mesh(), and reset().

◆ pressure_boundary_

VarFormBoundaryState polyfem::varform::FluidVarForm::pressure_boundary_
protected

Definition at line 58 of file FluidVarForm.hpp.

Referenced by build_basis(), and reset().

◆ pressure_space_

FESpace polyfem::varform::FluidVarForm::pressure_space_
protected

◆ primary_assembler_

std::shared_ptr<assembler::Assembler> polyfem::varform::FluidVarForm::primary_assembler_ = nullptr
protected

◆ pure_mass_

StiffnessMatrix polyfem::varform::FluidVarForm::pure_mass_
protected

Definition at line 68 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), and reset().

◆ pure_mass_ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::FluidVarForm::pure_mass_ass_vals_cache_
protected

Definition at line 63 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), build_basis(), and reset().

◆ pure_mass_assembler_

std::shared_ptr<assembler::HRZMass> polyfem::varform::FluidVarForm::pure_mass_assembler_ = nullptr
protected

Definition at line 75 of file FluidVarForm.hpp.

Referenced by assemble_mass_mat(), build_basis(), init(), load_mesh(), and reset().

◆ rhs_

Eigen::MatrixXd polyfem::varform::FluidVarForm::rhs_
protected

Definition at line 71 of file FluidVarForm.hpp.

Referenced by assemble_rhs(), prepare_initial_solution(), and reset().

◆ rhs_assembler_

std::shared_ptr<assembler::RhsAssembler> polyfem::varform::FluidVarForm::rhs_assembler_
protected

◆ space_

◆ t0

double polyfem::varform::FluidVarForm::t0 = 0
protected

Definition at line 79 of file FluidVarForm.hpp.

Referenced by init(), and reset().

◆ time_integrator

std::shared_ptr<time_integrator::ImplicitTimeIntegrator> polyfem::varform::FluidVarForm::time_integrator
protected

Definition at line 82 of file FluidVarForm.hpp.

Referenced by reset().

◆ time_steps

int polyfem::varform::FluidVarForm::time_steps = 0
protected

Definition at line 80 of file FluidVarForm.hpp.

Referenced by init(), and reset().

◆ use_avg_pressure

bool polyfem::varform::FluidVarForm::use_avg_pressure = true
protected

The documentation for this class was generated from the following files: